問題タブ [swagger-ui]

/ ではなく /docs/ にロードされるように、swagger-ui のパスを変更するにはどうすればよいですか? しかし、webjar swagger-spring-mvc-ui が他のすべてと同様に依存関係にあるエレガントなソリューションを探しています。

トップ レベルのパラメーターを使用する方法を理解しようとしています。次に、操作レベルで $ref を使用して、トップ レベルのオブジェクトで宣言された定義を参照します。

YAML は次のようになりますが、これを試してみると、空のパラメーターが表示されます。これの正しい構文を知っている人はいますか?

このためにアプリケーションからのすべての API を文書化しています。swagger UIを使用しています。

ここにサンプルコードがあります

としてリクエストURLを生成します

したがって、人々のパスを生成して/peopleいますが、「/ create_people」に変更する必要があるため、この機能をどのように実装できますか.

specここのコードの「パス」を変更してこれを試しました

それは機能していますが、次のように異なるリダイレクトURLを作成しています

これは、リクエスト URL ではなく API 名のみを変更する必要があるためです。

ここに絵の表現があります。

私たちはswagger-uiとnode.jsを使用しています

私はグレープ・スワッガーの宝石とSwaggerUIのスタンドアロン・インストールを使用しています。私の API ドキュメントはhttp://example.com/api/v1/docs/にあります。SwaggerUI はすべてのリソースを検出しますが、すべてのリクエストをhttp://example.com/v1/fooに送信します(URL に「api/」がありません)。何故ですか？

API ドキュメントを、個別に編集できる複数の JSON ファイルに分割しようとしています。私が見つけたすべての例は、それを分解するための "api":{} オブジェクトを持つ Swagger 1.2 スキーマを使用しています。これは 2.0 スキーマ ( http://json.schemastore.org/swagger-2.0 ) にはないようです。定義するのは、すべての API エンドポイントをその単一の配列にバンドルする単一の「パス」配列だけです。swagger-ui でのこれの効果は、すべてがバンドルされる単一の「デフォルト」カテゴリがあり、それを分割するように指示する方法がないことです。

TLDR: swagger 2.0 スキーマのパスから操作をどのように分割しますか

こんにちは、node.js アプリケーションで API を文書化するために swagger UI を使用しています。正常に構成され、正常に動作しています。

しかし、私は今、1つの深刻な問題に直面しています。

これが私のコントローラーからのサンプルのswaggerコードです

これには、次のような形式でpayload値を取るパラメーターがありますjson

しかし、私invalid jsonが

その後、サーバーがクラッシュしています。このパラメーターに検証を追加する必要があるため、この特定のパラメーターに検証を追加するにはどうすればよいですか。

複雑なオブジェクトのリクエスト本文を各フィールドに入力して、swagger で提示する方法はありますか?

簡単に言えば、私の API の 1 つが @RequestBody として Person (名前/姓のみを持っていると仮定) を期待している場合、この Person に swagger を提供する唯一の方法は、Person の json 全体を提供することです。たとえば、個別のフィールドごとに名前/姓の個別の入力を有効にする方法はありますか?

ジャージー + jaxrs (2.1) API の文書化に swagger(1.2) を使用しています。API の表示には swagger-ui を使用しました。http GET リクエストの場合、API エンドポイントに @QueryParam("token") としてクエリ パラメータがあります。Swagger はこのクエリ パラメータのフィールドを表示していますが、[Try it out!] をクリックすると、null値を受け取るたびにボタン。

@QueryParam("token") にも @ApiParam で注釈を付けましたが、うまくいきませんでした。誰かが私が間違っていることを説明してください。クエリ パラメータは実際に swagger で機能しますか?