問題タブ [openapi]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
swagger - Swagger(OpenAPI)でファイルを投稿する方法は?
Swaggerを使用してRESTサービスを文書化しています。私のサービスの1つでは、CSVファイルをアップロードする必要があります。parameters
JSONAPI定義のセクションに以下を追加しました。
SwaggerUIページにファイルアップロードオプションが表示されます。しかし、ファイルを選択して[試してみる]をクリックすると、次のエラーが発生します。
NS_ERROR_XPC_BAD_OP_ON_WN_PROTO:jquery-1.8.0.min.jsのWrappedNativeプロトタイプオブジェクトに対する不正な操作(2行目)
ページは継続的に処理されており、応答がありません。
何が間違っている可能性があるのか?
dictionary - Swagger HashMap プロパティ タイプ
モデル セクションで HashMap または Generic Object タイプを定義する方法はありますか? 製品を返す REST サービスがあり、それらの製品にはさまざまなオプションがあります。options プロパティは基本的に HashMap であり、id はオプション名で、その値はオプション値です。
swagger - OpenAPI でグローバル パラメータを定義する方法は?
自動生成ではなく、手作業で API ドキュメントを準備しています。すべての API に送信する必要があるヘッダーがあり、API 全体に対してグローバルにパラメーターを定義できるかどうかわかりません。
これらのヘッダーの一部は静的で、一部は API の呼び出し時に設定する必要がありますが、すべての API で同じです。各 API と各メソッドのパラメーターをコピーして貼り付けたくありません。将来的に保守可能。
API 定義による静的ヘッダーを見ましたが、誰かがそれらを設定または使用する方法についての単一のドキュメントはありません。
これはまったく可能ですか?
swagger - Swagger: プロパティが OpenAPI 2.0 のモデルを参照する (つまり、モデルをネストする) 方法は?
OpenAPI 2.0 でモデルをネストする方法を理解するのに苦労しています。
現在私は持っています:
私は他の多くの方法を試しました:
上記のどれも機能していないようです。
ただし、配列を使用すると問題なく動作します。
swagger - 定義された Swagger ルートの代替 (国際) スペルを提供する
エンドポイントを持つ Swagger の API 仕様に取り組んでいます。
このエンドポイントにも別のスペル (承認) を定義したいと思います。これは可能ですか?それとも、スペルごとに個別のルートを定義する必要がありますか?
swagger - Swagger/OpenAPI - $ref を使用して、再利用可能な定義済みパラメーターを渡します
のようなパラメータがあるとしましょうlimit
。これはいたるところで使用されており、更新する必要がある場合にどこでも変更しなければならないのは面倒です。
$ref を使用してこれを別の場所で定義し、再利用可能にすることはできますか? 誰かが機能の変更または改善を望んでいることを示唆するこのチケットを見つけましたが、それが今日すでに存在するかどうかわかりません。
swagger - OpenAPI (Swagger) で列挙型を定義するには?
Swagger UI の [モデル] タブに表示されるように、OpenAPI 2.0 定義で可能な「列挙型」値を定義する方法を知っている人はいますか? 例: https://petstore.swagger.io/#!/pet/addPetには、プロパティの列挙オプションがありstatus
ます。OpenAPI 2.0 でそのような列挙型を定義するにはどうすればよいですか?
java - Swagger: サードパーティ コードに ApiModelProperty を追加するにはどうすればよいですか?
Swagger を使用した Java プロジェクトがあります。それは swagger.json を生成する素晴らしい仕事をしますが、すべての出力フィールドをオプションとしてリストしていて、そのうちのいくつかを必須にする必要があります。@ApiModelProperty アノテーションを追加して、それが必要かどうかを指定できるので、これは私のコードでは問題になりません。
問題は、サードパーティの jar からのオブジェクトにあります。そのコードに注釈を付けることはできません。サードパーティのコードで @ApiModelProperty と同等の機能を作成するにはどうすればよいですか?
swagger - この POST JSON リクエストボディを OpenAPI (Swagger) で記述する方法は?
次の JSON 要求本文を使用する POST 要求があります。OpenAPI (Swagger) を使用してこのリクエスト ボディを記述するにはどうすればよいですか?
これまでのところ、次のことを試しましたが、 body の定義に行き詰まっていschema
ます。
ドキュメントのサンプルとして、入力本文をインラインで定義したいと考えています。