@Parameter中schema参数详解

在 OpenAPI 规范中，`@Parameter` 注解的 `schema` 参数用于定义参数的数据类型和格式，可以使用各种数据类型、格式和约束来描述参数。

下面是一些常见的 `schema` 参数选项：

- `type`：参数的数据类型，可以是数字、字符串、布尔值、数组等。常见的类型有 `integer`、`number`、`string`、`boolean`、`array` 等。
- `format`：参数的数据格式，例如日期、时间、日期时间、邮箱、URL 等。常见的格式有 `date`、`time`、`date-time`、`email`、`uri` 等。
- `enum`：参数的枚举值，用于限制参数的取值范围。例如，`enum: [red, green, blue]` 表示参数只能取 `red`、`green` 或 `blue` 中的一个值。
- `minimum` 和 `maximum`：参数的最小值和最大值。仅适用于数值类型的参数。
- `minLength` 和 `maxLength`：参数的最小长度和最大长度。仅适用于字符串类型的参数。
- `pattern`：参数的正则表达式模式，用于限制参数的格式。

除了上述选项外，还有一些高级选项可以用于描述参数的约束和格式，例如 `multipleOf`、`exclusiveMinimum`、`exclusiveMaximum` 等。

示例：

openapi: 3.0.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Get a list of users
      parameters:
        - in: query
          name: status
          schema:
            type: string
            enum: [active, inactive]
          description: Filter users by status
      responses:
        '200':
          description: OK

在上面的示例中，`status` 参数是一个字符串类型的参数，它的取值范围被限制为 `active` 或 `inactive`。通过 `schema` 参数，我们可以非常灵活地定义各种类型的参数，以及它们的格式、约束和限制。