問題タブ [swagger-ui]

PHPで作成されたjson-rpcサーバーにSwagger-uiを使用しようとしています。Swagger-PHPを使用して、Swagger-ui の json 苦情コンテナーを生成します。したがって、私は Swagger を初めて使用し、次のようなメソッドに注釈を使用します。

SWG\Operation では、json-rpc specに対応するもう 1 つの「メソッド」を追加する必要があります。その結果、すべてのリクエストは http の一部として POST メソッドを使用し、json コンテナはそれぞれに独自の「メソッド」を持ちます。

質問 - この問題を解決するには、どこから検索を開始すればよいですか?

私の英語でごめんなさい。ネイティブではありません。

私は春の webapp を持っています。swagger と swagger-ui を追加しました。Swagger をテストするためのダミー クラスを追加しました。

ビルド/デプロイ後、swagger ページにダミー クラスが表示されます (添付ファイル1を参照)。問題は、「リスト操作」に何も表示されないことです。生の出力は次のとおりです。

問題は、タグ「操作」の欠落またはこのようなものだと思います...しかし、わかりません（そして、これを修正する方法もわかりません）。助言がありますか？

Web API を文書化するために、swagger ui プラグインを使用しています。次のような JSON オブジェクトを返したい:

Person オブジェクト名に注意してください。

次のコードでこれを行うことができます：

残念ながら、戻り値の型は Person 自体ではなく HttpResponseMessage であるため、Swagger はモデルを HttResponseMessage として表示するだけです。それは私が望むものではありません。

戻り値の型を Person に変更して person オブジェクトを返すと、JSON 戻り値で Person オブジェクト名を取得できません。それだけを返します-

}

Person を返す方法はありますが、Person オブジェクト名を持つ JSON 文字列を持っていますか?

enunciateを使用して、REST API のSwaggerドキュメントを生成しています。私のレガシー Bean の 1 つにマップが含まれており、Swagger はこれについて不平を言っています。

Swagger がこれを処理できるように、Bean クラスにドロップできる注釈はありますか?

それを除いて、フィールドまたはクラス全体を単に無視するように Swagger に指示する方法はありますか? @XmlRootElementSwagger がアノテーションのないクラスを無視することは知っていますが、残念ながらBazBeanXML を受け入れる別のエンドポイントで使用されています。

この q&a を見たが、OP と同じ結果が得られなかったHow to post files in swagger?

私の swagger-node-express API でこの仕様を使用する

curl 経由で POST すると、curl -v -F file=@scrot.png http://127.0.0.1:3000/uploads/fileすべてが期待どおりに機能します。swagger-ui (v 2.0.2) 経由で投稿すると失敗します。どちらの状況でもプロキシを使用しましたが、swagger-ui は content-type を指定しておらず、データを渡していません。

curl による生の投稿の短縮 (上記のコマンドを使用)

swagger-ui を介した短縮された未加工の投稿

swagger-ui が正しく投稿されるようにするには、ルート/仕様をどのように構成すればよいですか?

Swagger を使用して、ServiceStack 3.9.70 で作成された残りのサービスを文書化しようとしています...

これは、ソリューションのレイアウトです。

swagger-ui を使用して、discoveryUrl: "/resources" を設定しました。

swagger html を開始すると、Product{n}.cs の 1 つの操作のみが表示されます。/metadata を実行すると、すべての操作が表示されます。

これは、私がソリューションをどのように構築したかで何かありますか?

Grape (Rails 4)、Swagger、および Swagger-UI を使用して、Grape API を文書化しています。ここで、Swagger の例のようにルートをグループ化する方法を知りたい: http://petstore.swagger.wordnik.com/

それが私の Swagger-UI の現在の外観です。

Swagger を ServiceStack で動作させようとしています。Web サーバーはファイアウォールの背後にあり、インターネット (my.domain.de:80) からアクセスされます。その後、リクエストはポート 8070 の Web サーバーに転送されます。

swagger ページにアクセスする/api/resourcesと、ServiceMethods のリストにアクセスして取得できますが、操作のリストを取得できません。

フィドラーを使用して結果を検査すると、彼/apiが欠落しているため、swagger は の/resources/ServiceName代わりにから操作のリストを取得しようとします/api/resources/ServiceName。

Swagger-UI で次のエラー メッセージが表示されます。

パスhttp://my.domain.de/resource/ServiceNameから API 'ServiceName' を読み取ることができません(サーバーが Not Found を返しました)

SwaggerConfig:

ServiceStack 構成:

Update(2) WebHostUrl を設定しない場合、ServiceStacks リソース サービスからの初期応答の BasePath には、 webserver からのポート番号が含まれますbasePath=http://my.domain.de:8060/api。しかし、ファイアウォールでは、このポートは到達可能ではなく、到達可能にしたくありません。

web.config:

アップデート

初期応答では、ベースパスは次のとおりです。

そして my.domain.de とは、ポート、url-path、クエリ文字列、またはフラグメントのないホスト名だけである現実世界の url を意味します (実際にウィキペディアで正しい名前を確認しました;)

StackOverflow でこの他の質問を見つけましたが、役に立ちませんでした。 Service Stack を使用した Swagger が機能しない

/api返された ServiceListに ServiceStack/Resources Service を追加するにはどうすればよいですか?

ジェネリック型の応答オブジェクトのドキュメントに関して、Swagger の ServiceStack 実装に問題があります。厳密に型指定された応答オブジェクトは正しく文書化されて表示されますが、ジェネリック型のオブジェクトが応答として使用されると、文書化は不正確になり、誤解を招きます。

DTO を要求する

応答 DTO

応答 DTO タイプ

例は非常に簡単です。ハックや巧妙なことは何もありませんが、これは私が Swagger からすぐに取得できるサンプル ドキュメントです。

ご覧のとおり、ジェネリック型は正しく文書化されておらず、代わりに他の型が使用されています。すべての応答に同じ ServiceResponse ラッパーを使用しているため、これは全体的に発生しています。