問題タブ [swagger]

私は、主にAPI駆動のRailsアプリを書き直しています。GrapebyIntrideaとgrape-swagger gemを使用して、ドキュメントのSwaggerUIを有効にしています。

だから私は単純なhelloworldアプリを実行しています。現時点ではJSON解析エラーが発生していますが、Swaggerテストから発見できるようです（次に調べます）。/swagger_doc.jsonを指すSwaggerUIをRailsアプリに配置して、ビルドするときにドキュメントが適切にビルドされていることを確認したいと思います。

RailsアプリのどこにSwaggerUIを配置しますか？パブリックディレクトリ？

swagger-uiを使用しますが、phpでサーバーを構築する方法がわかりません.and Response bodyが「sd」と「s」に応答しないのはなぜですか、phpでswagger-uiを使用する方法は?私は試しています大変です、私を助けてくれる人はいますか？

このサンプルアプリケーションを見たことがありますが、play2アプリケーションでswaggerを使用することに興味があります。そのため、そのプロジェクトのように、Build.scalaに依存関係を含めました。

しかし、それは私に未解決の依存関係を与えます。

私も試しました：

Play 2.1-RC1を使用していますが、それでも見つかりません。

誰かが私がどこが間違っているか知っていますか（私はこの最後に上から試したときにいくつかのエラーがあると思います..）

初めてswaggerを使い始めたばかりですが、XmlDocumentionコメントから実装ノートに何かを表示させる方法がわからないようです。

json出力の特定のフィールドにデータを入力する方法についての言及がないまま、ドキュメントを数時間精査しました。

これを動的に実行し、このデータの静的jsonファイルを作成する必要はありません。特定の出力を取得するために指定するフィールドに関するチュートリアルまたは追加のドキュメントがあります。

また、UI出力のアクションメソッドの入力モデルに基づいてサンプルのjsonリクエストを手動で表示することなく表示する方法もあります。

編集：

また、私が遭遇した別の問題は、Authorize Swagger UIとしてマークされた単純なgetメソッドが完全に壊れ、javascript apiのheadersオプションにAuthorizeヘッダー（Bearerトークンを使用しています）を追加しようとすると、承認トークンが発生することです。送信されないコードは次のとおりです

メッセージハンドラーでリクエストを受信すると、authHeaderはnullであり、ヘッダーコレクションにはまったく存在せず、ベアラートークンはこれまで正常に機能していましたが、Fiddlerを使用すると、SwaggerAPIで何かを行う必要があります。それで私は行方不明です私は手紙にほぼ正確にドキュメントに従いました、そして上記の機能は認証以外でうまく働きます、そして私は実装ノートを移入する方法を理解することができません

私は JAX-RS と JAXB を使用して REST Api に取り組んでいます。また、Swagger を使用して API のドキュメントを生成したいと考えています。https://github.com/wordnik/swagger-core/wiki/java-jax-rsの例に従いました。そこで、以下のように web.xml の初期化パラメーターに com.wordnik.swagger.jaxrs.listing を追加しました。

localhost:9090/rapi/api-docs.json URL にアクセスしようとすると、次のエラーが表示されます。

以下のように、カスタム JAXBContextProvider に com.wordnik.swagger.core を追加して修正しました。

これにより、別のエラーが発生しました。

私は jaxb.in​​dex ファイルを使用して、コンテキストが JAXB アノテーションを持つクラスを認識できるようにしていますが、ドキュメンテーション クラスを含む swagger パッケージには jaxb.in​​dex ファイルがありません。Swagger を JAXB および JAX-RS と統合するときに、同様の問題に遭遇した人はいますか?

私は Swagger-UI を使用して独自の API を参照しています。この API はグレープで構築され、グレープ-スワガーで自動的に文書化されています。

私は見つけたすべての提案をグーグルで試してみましたが、POSTを機能させることができません。ここに私のヘッダーがあります：

提案されたすべてを投入しました。supportedSubmitMethods ですべての HTTP メソッドを有効にし、POSTMAN Chrome 拡張機能を使用して API をテストしましたが、完全に動作します。ユーザーを適切に作成し、正しいデータを返します。

ただし、swagger の投稿で得られるのは、サーバーのレポートだけです。

そして、このように見えるswagger応答：

リクエスト URL

レスポンスボディ

応答コード

応答ヘッダー

OPTIONS 応答も POSTMAN でテストしましたが、以下のとおりです。

紹介スライドで闊歩についての言及を見つけました。しかし、他にはありません。何かまだ終わっていませんか？

編集：どうやらTo Doリストにあるようです。

RestAPI を自動的に文書化する良い方法はありますか?

私のプロジェクトでは、REST API の作成に Maven、Jetty、Swagger、Java、および Jersey を使用しています。また、Swagger を使用して、API の見栄えの良いドキュメントを作成しています。

3つの問題ではなく、ほとんどすべてが問題ありません。最初に - これは私の web.xml です

1) listnig の先頭から api-docs を削除するにはどうすればよいですか?

そして、パスの先頭にある /api-docs を削除したい..

2) API から「/api-docs/resources」を削除するにはどうすればよいですか? 「リソース」ではなく、「従業員」クラスのみを使用します。

3) 入力http://localhost:8080/rest/api-docs/employeeすると、メソッドと空の「/」メイン URL が表示されます。削除できますか?

私は多くの構成を試しました。私は何かを逃したのですか？

MultivaluedMapSwaggerを使用してJerseyのparamにアノテーションを付けてAPIドキュメントを作成することはできますか?

次のような小さなコードがあります。

そして、Swagger と Swagger UI を使用してドキュメント データを@ApiParam生成するために使用したいと考えています。JSON

@ApiParamformParams の前に置くMultivaluedMap<String, String>と、機能しません。Swagger はパラメーターをリストできません。