swagger3.0 如何添加schema
时间: 2023-10-31 10:59:24 浏览: 256
mondrian设置schema3.0工具
在 Swagger 3.0 中,可以使用 OpenAPI Specification 来定义 RESTful API 的接口和数据模型。要添加模型或数据模式(schema),可以在 OpenAPI 规范文件中使用 components/ schemas 对象进行定义。
例如,以下是一个使用 components/ schemas 对象定义用户模型的示例:
```
components:
schemas:
User:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
format: email
```
在这个示例中,我们定义了一个名为 "User" 的模型,它有三个属性:id、name 和 email。其中,id 属性的类型为整数,而 name 和 email 属性的类型为字符串。此外,我们还使用了 format 关键字来指定 email 属性的格式为电子邮件格式。
定义好模型之后,我们可以在 API 的路径定义中使用这个模型,例如:
```
paths:
/users:
get:
summary: Returns a list of users
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
```
在这个示例中,我们定义了一个 GET 请求路径 /users,它将返回一个用户列表。在响应的 schema 属性中,我们使用了 $ref 关键字来引用之前定义的 User 模型,从而指定响应的数据格式。
阅读全文