如何在OpenAPI中要求至少两个参数中的一个？

Question

我使用的是OpenAPI3，有两个查询参数，其中至少有一个是必需的，但哪个并不重要。

if parameter_1 OR parameter_2:
    do stuff
else:
    error

这在OpenAPI3中可能吗？就我所见，规范和JSON模式规范中都没有提到它。

Answer 1

此场景非常类似于互斥参数。基本上，您可以使用对象类型参数，其中parameter_1和parameter_2是对象属性；这样的对象将序列化为？parameter_1=value1&parameter_2=value2。可以使用minproperties或anyof表示“至少一个of”约束。

openapi: 3.0.2
...
paths:
  /foo:
    get:
      parameters:
        - in: query
          name: param
          required: true
          schema:
            type: object
            properties:
              parameter_1:
                type: string
              parameter_2:
                type: string
            additionalProperties: false

            # Option 1
            minProperties: 1

            # Option 2
            # anyOf:
            #  - required: [parameter_1]
            #  - required: [parameter_2]

还有一个现有的特性请求支持parameters列表中各个参数之间的相互依赖关系:
https://github.com/oai/openapi-specification/issues/256