Swagger Open API 3.0 で別のパラメータが使用されている場合に、パラメータが条件付きで必須であることを示す方法 質問する

Swagger Open API 3.0 で別のパラメータが使用されている場合に、パラメータが条件付きで必須であることを示す方法 質問する

RESTful API を作成し、現在この API の使用のために Open API 3.0 JSON 表現を定義しています。

別のパラメータが存在する場合、条件付きでパラメータの使用を要求しています。条件付きである必要があるため、 または のどちらも使用できません。 として定義し、 and / or で、他のパラメータが使用されている場合に必須であると記述すればよいでしょうかrequired: true。または、パラメータ間の依存関係を定義する方法はありますか。何も見つかりません。required: falserequired: falsesummarydescription仕様ではこのようなケースについて言及しています。

ベストアンサー1

ドキュメントより:

パラメータの依存関係

OpenAPI 3.0はパラメータの依存関係と相互排他パラメータをサポートしていません。github.com/OAI/OpenAPI-仕様/問題/256実行できることは、パラメータの説明に制限を文書化し、400 Bad Request 応答でロジックを定義することです。

おすすめ記事