OpenAPI Specification (OAS) 是一个规范,用于描述 RESTful API。它允许开发者定义 API 的各个部分,包括路径、操作、参数、响应等。OpenAPI 规范的最新版本是 OpenAPI 3.0,它提供了一种更灵活的方式来定义 API。
### 基础类型
在 OpenAPI v3 中,基础数据类型主要包括以下几种:
- `string`:字符串类型,可以使用格式(format)来进一步限定,如 `date-time`、`email`、`uri` 等。
- `number`:数值类型,可以用 `format` 来指定为 `float` 或 `double`。
- `integer`:整数类型,不允许有小数点。
- `boolean`:布尔类型,只有 `true` 和 `false` 两个值。
- `array`:数组类型,可以包含任意类型的元素。
- `object`:对象类型,可以包含多个属性,每个属性都有自己的类型。
### 官网
OpenAPI 的官方网站是 https://www.openapis.org/,在这里你可以找到最新的规范文档、工具列表以及其他资源。
### 支持 float
在 OpenAPI v3 中,`number` 类型确实支持浮点数,可以通过设置 `format` 为 `float` 来明确表示这是一个单精度浮点数。例如,在定义一个参数或响应体属性时,你可以这样写:
```yaml
parameters:
- name: exampleParameter
in: query
description: A floating point number
required: true
schema:
type: number
format: float
```
这样就定义了一个名为 `exampleParameter` 的查询参数,其类型为单精度浮点数。
在 OpenAPI v3 中,`type` 字段本身并不直接支持 `float` 这个值。取而代之的是,你应该使用 `number` 类型,并通过 `format` 字段来指定具体的数字格式,比如 `float` 或 `double`。
例如,如果你想要定义一个浮点数类型的参数,你可以这样做:
```yaml
parameters:
- name: exampleFloat
in: query
description: A floating point number
required: true
schema:
type: number
format: float
```
在这个例子中,`type: number` 表示这是一个数值类型,而 `format: float` 则进一步指定了这个数值应该是一个单精度浮点数。
所以,总结一下,虽然 `type` 不能直接写成 `float`,但是通过结合 `type: number` 和 `format: float`,你可以实现同样的效果。