在Swagger Open API 3.0中使用另一个参数时，如何指示一个参数是有条件的必填参数 [英] how to indicate that a parameter is conditionally required when another parameter is used in Swagger Open API 3.0

问题描述

我已经创建了一个REST风格的API，现在我正在定义Open API 3.0 JSON表示以使用此API。

当存在另一个参数时，我要求有条件地使用参数。所以我不能真正使用required: true或required: false，因为它需要是有条件的。我是否应该将其定义为required: false，然后在summary和/或description中说明在使用其他参数时它是必需的？或者有没有一种方法来定义参数之间的依赖关系？我没有找到任何in the specs提到这样的案例。

推荐答案

来自文档：

参数依赖项

OpenAPI 3.0不支持参数依赖和互斥参数。github.com/OAI/OpenAPI-Specification/issues/256处有未完成的功能请求。您可以做的是在参数描述中记录限制，并在400错误请求响应中定义逻辑。

• 有关详细信息-swagger.io/docs/specification/describing-parameters

这篇关于在Swagger Open API 3.0中使用另一个参数时，如何指示一个参数是有条件的必填参数的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！