問題タブ [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.

0 投票する
0 に答える
3846 参照

swagger - swagger-codegen-cli:java.lang.RuntimeException:swagger の入力または構成がありません

Pythonのコードを生成するために、コマンドプロンプトでこのコマンドを実行しようとしています:

そして、それは私にこのエラーを示しています:

このファイルをブラウザで開くと、次のものが含まれています。

0 投票する
1 に答える
775 参照

enums - Swagger、YAML: リクエストとレスポンスのオブジェクト モデルは、1 つのフィールドを除いて同じです

API の Swagger 定義を定義していて、このユース ケースに遭遇しました。

要求と応答のオブジェクト モデルの定義はまったく同じに見えます。ただし、オブジェクトには get 操作中により多くの列挙値を返すフィールドが 1 つありますが、put 操作では最小の列挙値に制限されます。同じフィールドの異なる列挙値を条件付きで参照して、定義の重複を回避することは可能ですか? この制限を克服するために、リクエストとレスポンスのモデル定義全体を再作成したくありません。

これが私の例です。

以上、気になる点が2点ありました。1) EntryRequest の場合、API は PUT 操作で ENABLE/DISABLE のみを受け入れますが、API は GET 操作でそれらすべてを返します。条件付きで entryStatus プロパティへの参照を作成したいと思います。出来ますか?2) また、entryStatus を除くすべては、EntryRequest と EntryResponse オブジェクト モデルの両方で同じです。entryStatus フィールドの違いを表すために、これも複製したくありません。

それを行う方法はありますか?

編集: これについてさらに学ぶと、これはyaml関連のクエリであると感じます。しかし、誰かが同様の状況に直面し、どのように対処したかを確認するために、ここに掲載したいと思います. または、これを処理する方法に関する推奨事項があるかどうかを確認します。同じフィールドに異なる列挙型をタグ付けするには、次のようにできると思います。

しかし、それでも、entryStatus フィールドへのマッピングが異なるリクエスト オブジェクトとレスポンス オブジェクトの複製を作成する必要があります。これを処理するためのより良い方法があれば知りたいです。

0 投票する
11 に答える
81698 参照

mocking - Swagger/OpenAPI モック サーバー

Swagger ファイルに API リファレンスがあります。非常に単純なモックサーバーを作成したいので、たとえば次のように呼び出します。

mymockurl.com/users定義済みの JSON を返します (データベースに接続する必要はありません)。

これを行う最も簡単な方法は何ですか? 私はバックエンドの人ではありません。

0 投票する
4 に答える
8088 参照

django - Django REST フレームワーク Swagger 2.0

Swagger UI を構成するのに苦労しています ここに非常に説明的なドキュメントがあります: https://django-rest-swagger.readthedocs.io/en/latest/

YAML docstring は非推奨です。Pythonコード内からSwagger UIを構成する方法を知っている人はいますか? または、API エンドポイントをグループ化し、各エンドポイントにコメントを追加し、Swagger UI にクエリ パラメータ フィールドを追加するには、どのファイルを変更する必要がありますか?

0 投票する
1 に答える
6490 参照

swagger - OpenAPI 2.0で混合型配列(要素型が異なる)を定義する方法は?

次の JSON を OpenAPI 2.0 (Swagger 2.0) YAML 定義にマップしようとしていますが、混合配列タイプをスキーマに設定する方法がわかりません。

今、私の OpenAPI 定義は次のとおりです。

ただし、これは配列内の整数を許可しません。

混合型配列を定義する方法はありますか?