問題タブ [swagger]

私は Play2 フレームワークを初めて使用する Android/Java 開発者です。swaggerを使用して RESTful API にドキュメントを生成しようとしています。

Play2 webapp に swagger を組み込み、単純な api-docs.json を生成することができました。私が欠けている唯一の部分は、モデルの説明です。それに応じて /controllers と /models にユーザーコントローラーとユーザーモデルがあります。

例とまったく同じようにモデルに注釈を付けようとしました

結果は次のとおりです。

何か案は ？

OSX10.7.5でsource2swaggerを使用しようとしています

「json」に依存するので、それをインストールして、以下のように実行しようとしています。

ここで機能していないものと、source2swaggerに「json」を表示させる方法を教えてもらえますか？

source2swagger は、1 つの json ファイルにすべての API を含む swagger 仕様を生成します。swagger-ui は実際にそれを使用できますか? 生成された json ファイルを swagger-ui で探索すると、単一の json ファイルの説明/操作を使用するのではなく、仕様のパスから API の説明を読み取ろうとします。

JBoss AS 7.1.1、RestEasy 2.3.5.Final、Swagger 1.2.0、Spring3.1.1を使用しています

これが私のweb.xmlです。

Spring application-contextとservlet-context.xmlは問題なく、私のRESTサービスは接続されて機能しています。しかし、Swaggerだけが機能していません。これがApiListingResourceです。

チェックしたところ、RestEasy2.3.​​5で@Contextインジェクションが機能していません。とにかく、カスタム構成リーダーを作成しました、

アクセスしようとすると常にNPEエラーが発生しますhttp://localhost:8080/js/api-docs

Swagger API ドキュメント内には、apis 配列の横にある json 内にモデル オブジェクト エントリがありますが、それに関するドキュメントはありません。この「モデル」部分をどのように使用できますか?

私はこの http://petstore.swagger.wordnik.com/#!/store/placeOrder_post_2DataTypeのようなServiceStack.ServiceHost.ApiMemberものを達成しようとし ています私、上記のURLのように。

どうすればこれを達成できますか？

私はこのような単純なセッションオブジェクトを持っています

私が闊歩UIに行くとき、私は要素を見ることができます

ただし、要素を入力して今すぐ試すを押すと、リクエストの内容がサーバーに送信されていないことがわかります。

parameterType="path" で poco を正しく構成しましたか、それともここで何か他のことをする必要がありますか? お知らせ下さい。

ServiceStackはSwaggerのモデルをサポートしていますか？以下のサンプルコードでは

UserDataを複合型またはコンテナ型にしたいのですが。ただし、これらの1つとして定義すると、SwaggerUIに表示されるのはテキストエリアボックスだけです。ペットショップの例にあるModelとModelSchemaのリンクをオンラインで取得できません。

http://petstore.swagger.wordnik.com/#!/pet/addPet_post_1

RPC タイプの API アプリを実装しています。Java on play フレームワークを使用しています。私はすでにswaggerモジュールを使用して、各「URL」がコントローラーの異なる静的関数にマップされている単純なrest APIのswaggerドキュメントを生成しました。ただし、ここでは、1 つの URL と 1 つの静的関数を API ドキュメントの複数のアクションにマップする必要があります。

基本的な構造はかなり古典的です

すべてのアクションは、play フレームワークのルート ファイルなどで、RPCController マッパーの同じ静的関数にマップされます。

/rpc/ routes.RPCController.rpc()

swagger および swagger-core doc 生成を使用して、すべてのアクション、param クラス、および結果クラスを文書化するにはどうすればよいですか? swagger-play2 モジュールの @Api* アノテーションだけを使用することは可能ですか?

参照:

-Swagger : https://developers.helloreverb.com/swagger/

-Swagger-core : https://github.com/wordnik/swagger-core

ServiceStack での Swagger 統合に関する次の問題の解決策を探しています。

必要なプロパティ ID を持つ RequestObject があります。次のルートを提供したい：

基本的に、これにより、Id をクエリ文字列で提供するか、ServiceConsumer へのパスとして提供するかを選択できます。

Swagger UI は 2 つのルートを正しく表示しますが、API-Member 属性がそれを ParameterType 'path' または 'query' として指定できないため、両方の方法をテストできません。

ソース: https://gist.github.com/JohannesFerner/5317496

特に対応するルートに API メンバー仕様を提供する方法、またはパスとクエリとして有効であることを定義する方法はありますか?

このような：