查询中的必需参数未在用户界面中标记

时间:2019-05-08 12:43:15

标签: java swagger swagger-ui

我已经在yaml文件参数中标记了

     parameters:
     - name: someID
       in: query
       description: The some ID
       required: true
       schema:
        type: uuid

在生成的Java类中,该字段被标记为必填字段,这很好,但是不幸的是,在Swagger UI上却没有。这是有问题的,因为我想在失败请求之前通知用户该文件是必需的。

1 个答案:

答案 0 :(得分:1)

在OpenAPI 2.0(swagger: '2.0')中,查询参数不使用schema,而直接使用type关键字。请注意,there's no type: uuid则需要type: string + format: uuid

parameters:
  - name: someID
    in: query
    description: The some ID
    required: true
    type: string
    format: uuid

Swagger UI通过在参数名称旁边显示红色的* required注释来指示必需的参数:

How required parameter is indicated in Swagger UI