問題タブ [swagger-editor]

次のような配列を含む JSON を返すことができる静的な swagger ファイルを使用して、API を文書化しようとしています。

ポリモーフィズムを使用するか、複数の例を明示的に定義して、仕様を定義するいくつかの異なる方法を試しました。例は常に次のようになります。

あるいは単に：

swagger 仕様で例を定義して、swagger-ui によって表示されるサンプル ペイロードに、最初に記述した JSON のようなタイプ A の例とタイプ B の例を含む配列が含まれるようにする方法はありますか?

したがって、本体パラメーターが必要な場合は、スキーマが必要であることを理解しています。問題は、スキーマをどのように定義しようとしても、複数の本体パラメーターを持つことができないことです。これは私が試した方法の1つの例です。どんな助けでも素晴らしいでしょう！

次のような Swagger YAML 関数があります。

私はコンテンツタイププロデュースを次のように持っています:

しかし、その後でも、私はswagger検証エラーを持っています

私の質問は - 画像応答を書き込むための最適化された方法はありますか、それとも画像応答の検証を除外する方法はありますか???

前もって感謝します。

私は次のyamlを持っています

エディターの「Try This」フォームでは、POST のプレビューは正しく表示されます (JSON は投稿本文にあり、コンテンツ タイプは正しいです)。

[

しかし、「リクエストの送信」ボタンを押すと、JSON が URL エンコードされた文字列としてスローされ、本文は送信されないようです。

今日、swagger-editor のクローンを作成してビルドし、サーバーに配置してローカルでホストし、ビルド中の API を試してみました。

本文を URL エンコードされた文字列として送信するのはなぜですか?

I'm attempting to document my API using Swagger by writing the documentation in the Swagger editor and then loading it into the Swagger UI. I used the editor and downloaded my JSON file and then changed the /dist/index.html file within the UI to point to my local file using:

The only thing I changed within the file is the use of the spec var to point to my JSON file, however when I open the UI, it displays a blank UI page with the message "Finished Loading Resource Information. Rendering Swagger UI..." I would just like to display the documentation I created in the editor in the UI without having to host the specs, is there something I'm missing?

PDF ファイルを返す必要がある、swagger REST API に get 呼び出しがあります。構文エラーを発生させずにこれを行う方法に関する明確な例/ドキュメントはありません。

と

と

すべて失敗します。これは可能ですか？

ドキュメントには Swagger 2.0 を使用しています。私たちは、データ設計ドキュメントからプログラムで swagger 2.0 仕様を作成しています。

私たちのモデルは非常に複雑でネストされています。インラインで定義されたネストされた配列オブジェクトを定義できることを理解したいと思います。

例：

モデルでこれに遭遇する多くのケースがあり、#ref を定義することは、現時点では考慮したくないオプションです。これはインラインで処理する必要があります。

次の投稿によると: https://github.com/swagger-api/swagger-editor/issues/603#evententer code here t-391465196 は、インラインで定義されたネストされた配列オブジェクトの処理をサポートしていないようです。

多くの大企業は非常に複雑なデータ モデルを持っているため、この機能を swagger 2.0 仕様でサポートしたいと考えています。

この機能を追加することについて何か考えはありますか。

出力が次のようになるように、swagger エディターで 3 つの列を指定する方法:

この YAML コードの swagger があり、独自の型 (MyOwnType という名前) を作成する必要があります。

「MyOwnType」を使用すると、コンパイル エラーが発生します。

「MyOwnType」という定義を作成しました。スキーマでは「$ref: '#/definitions/MyOwnType'」のように使用できます。

しかし、パラメーターの型で "MyOwnType" 定義を使用するにはどうすればよいでしょうか?