首页 > 解决方案 > 是否可以在 Openapi 3.0 中指定一个端点所需的参数和可选的另一个端点?

问题描述

我正在使用 Openapi 3.0,并且我正在尝试创建一个查询参数,该参数对于一个端点是必需的,而对于另一个端点是可选的。由于现在使用模式定义参数,我不知道这是否可能。

标签: swagger-codegenopenapi-generator

解决方案


是的,在 OpenAPI 3.0 和 2.0 中都是可能的。在参数的上下文中,required属性是参数级属性,而不是模式属性。

paths:
  /something:
    get:
      parameters:
        - in: query
          name: foo
          required: true  # <-----
          schema:
            type: string
      ...
  /something-else:
    get:
      parameters:
        - in: query
          name: foo
          required: false  # <----- Can be omitted because parameters are optional by default
          schema:
            type: string
      ...

推荐阅读