問題タブ [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.
scala - リクエストボディが単一のオブジェクトまたはオブジェクトのリストである可能性があることを Swagger に伝えます
私は Scala で Swagger を使用して、REST API を文書化しています。POST、PUT、および DELETE の一括操作を有効にし、同じルートで単一のオブジェクトまたはオブジェクトのコレクションを本文コンテンツとして受け入れるようにしたいと考えています。
パラメータがタイプAの値のリストまたはタイプAの単一の値であることをSwaggerに伝える方法はありますか?
REST の可変引数のようなもの。
swagger - Swagger 2.0 で複数のパラメータをグループ化する方法は?
複数のパラメーターをグループ化して、複数のルートで参照することはできますか?
たとえば、すべてのルートで必要なパラメーターの組み合わせがあります。これらはグローバル パラメータとして定義されます。どうすればそれらをグループ化できますか?
私は次のような定義を考えています。
そして、私のルートでグループ全体を参照します:
これは Swagger 2.0 で可能ですか?
swagger - Swagger で、スキーマ パラメータと共にファイルを使用する API を定義する方法は?
Swagger を使用して、実際のファイルとファイルの内容を記述するスキーマ オブジェクトを受け入れる API を定義しようとしています。Swagger YAML のスニペットを次に示します。ただし、Swagger Editor では検証されません。
Swagger Editor は、次の検証エラーをスローします。
Swagger エラー: データが「oneOf」のスキーマと一致しません
何か不足していますか？または、これは Swagger のサポートされている機能ではありませんか?
json - OpenAPI: (複雑な) JSON 値を受け入れるスキーマ
私が Swagger 2.0 仕様を書いている API は、基本的に任意の JSON 値のストアです。
値を読み取るパスと、事前定義されていない深さの JSON 値 (null、数値、整数、文字列、オブジェクト、配列) を格納するパスが必要です。
残念ながら、Swagger 2.0 は入力と出力のスキーマに対して非常に厳密であり、JSON スキーマで許可されているスキーマのセット全体を許可していないようです。Swagger エディターでは、たとえば、混合値 (たとえば、ブール値または整数のいずれかになるプロパティ) または大まかに定義された配列 (項目の型を厳密に定義する必要があります) およびオブジェクトは許可されません。
だから私はMixedValueスキーマを定義することで回避策を試みています:
しかし、Swagger Editor は、大まかに定義されたobjectandarrayプロパティを拒否します。
質問: - この問題を回避する方法はありますか? - それは単なる Swagger Editor のバグですか、それとも Swagger 2.0 仕様の強い制限ですか? - 必要なものを指定するためのより良い方法 (ベスト プラクティス) はありますか? - 私の API 仕様を使用する一部の言語では、swagger によって生成されるコードにいくつかの制限が予想されますか?
odata - Swagger とは何ですか? また、OData に関連していますか?
私は Microsoft スタックに精通しています。一部の安らかなサービスに OData を使用しています。最近、API ドキュメントの Swagger に出会い、OData との関係を理解しようとしています。どちらもRESTful仕様のようです。広く使われているのはどれ？
swagger - $ref を使用すると Swagger スキーマ プロパティが無視される - なぜですか?
時間を格納する単純な文字列を使用して、時間間隔の Swagger モデルを構築しようとしています (日時もあることがわかっています)。
何らかの理由で、生成された HTML には、lowerBound と upperBound の「説明」が表示されず、元の Time の「説明」のみが表示されます。これは、私がこれを正しく行っていないと思います。
したがって、問題は、モデルをタイプとして使用することが、実際に私がやろうとしているようにできるかどうかです。
swagger - swagger を使用してパスにオプションのパラメーターを定義する方法
私の REST Web サービスには GET メソッドで動作する関数があり、2 つのオプションのパラメーターがあります。
Swagger で定義しようとしましたが、 asを設定した後にNot a valid parameter definitionというエラーが発生しました。requiredfalse
required値を設定するtrueとエラーがなくなることがわかりました。これが私の Swagger コードのサンプルです。
本文のパラメーターまたはクエリのパラメーターではこれを経験しませんでした。この問題は、パスのパラメーターにのみ関連していると思います。swagger仕様ファイルにも解決策が見つかりませんでした。
Swagger でオプションのパラメーターを定義する他の方法はありますか、それともコードに誤りがありますか?
どんな助けでも大歓迎です。
openapi - Swagger / Open API 2.0 共通の応答ヘッダーを宣言できますか?
各応答構造にコピーせずに、すべての応答に存在するカスタム応答ヘッダーを宣言することは可能ですか?
swagger - OpenAPI(Swagger)で同じパスに異なるボディパラメータを定義する方法は?
Content-Typeヘッダーに基づいて 2 種類の本文パラメーターを持つことができるサービスがあります。
パスの例/Pet：
が使用されている場合
Content-Type: application/somecustom.resource+json、POST はPetbody パラメーターとして使用できます。が使用されている場合
Content-Type: application/somecustom.function+json、POST は別のボディ パラメータを使用して関数を呼び出し、別の応答を返す必要があります。
これを OpenAPI (Swagger) で明示する方法に関する提案はありますか?