如何在openapi中描述可选参数

时间:2020-08-18 13:38:50

标签: openapi restapi swagger-3.0

我有一个端点,其中过滤器作为查询参数。我想使过滤器为可选。问题是当我在端点的实现中发送不带任何参数的请求时,我得到一个包含所有空值文件的过滤器对象,而不是filter = null。我尝试向方案添加nullable:true,default:null,required:null并没有成功

/api/v2/bars:
get:
  operationId: getBarsList
  parameters:
    - name: filter
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/Filter'
components:
 schemas:
   Filter:
    type: object
    properties:
      id:
        type: integer
        format: int64
      name:
        maxLength: 30
        minLength: 1
        type: string
    .....

0 个答案:

没有答案