問題タブ [openapi]

プロパティを null または参照として指定する方法は? jsonschema を使用してプロパティを null または参照として指定する方法について説明します。

私は闊歩で同じことをしようとしています。

上記の答えを要約すると、jsonschema を使用すると、次のことができます。

答えのキーポイントは の使用でしoneOfた。

私の質問の要点は次のとおりです。

1. DRY にしたい複雑なオブジェクトがあるので、swagger 仕様全体で再利用するために定義セクションに入れます。他のプロパティの値。応答オブジェクトなど

2. 私の仕様のさまざまな場所で、プロパティはそのようなオブジェクトへの参照である場合もあれば、null である場合もあります。

oneOfまたは をサポートしていない Swagger でこれを指定するにはどうすればよいanyOfですか?

注: 一部の swagger 実装では、x-nullable(またはそのようなものを使用して) プロパティ値を null にできることを指定しますが、オブジェクトをそれが参照するものに$ref 置き換えるx-nullableため、 の使用は無視されるように見えます。

応答タイプを記述するために、swagger の構文に苦労しています。私がモデル化しようとしているのは、動的なキーと値を持つハッシュ マップです。これは、ローカライズを許可するために必要です。言語は異なる場合がありますが、常に英語を提供する必要があります。

応答は、JSON では次のようになります。

最初はこんな感じだったのですが、名前の部分の書き方がわかりません。AdditionalProperties が鍵のようですが、頭を包むことはできません。また、この構文では英語のテキストの要件が謎であり、例も期待どおりに機能していないようです。UI に空の $folded: が生成されます。

しかし、これは以下を生成します:

これには、結果がキーとして言語コードを持ち、ハッシュ マップの値としてテキストを持つという手がかりもありません。

swagger.json私のサイトのパブリック API が自動的に検出されるように、配置する URL (または合意された名前)に関する仕様または規則はありますか?