java - 查询中必需的参数未在 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 关键字。请注意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 注释来指示所需参数: