UI 中未标记查询中的必填参数

Question

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

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

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

Answer 1

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

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

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

Required parameters in query are not marked in UI