swagger3 @schema的用法
时间: 2024-01-17 08:15:18 浏览: 561
在 swagger3 中,"@schema" 是一种用于指定数据模型的注解。可以使用 "@schema" 注解来定义一个数据模型,然后在 API 文档中引用该模型。
具体用法如下:
1. 定义一个数据模型
```yaml
components:
schemas:
User:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string
```
2. 在 API 文档中引用该数据模型
```yaml
paths:
/users:
get:
summary: Get all users
responses:
'200':
description: A list of users
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
```
在上面的示例中,我们在 API 文档中定义了一个 GET 请求,该请求返回一个包含用户信息的数组。在响应的内容类型为 application/json 时,我们使用 "@schema" 注解来引用之前定义的 "User" 模型。
阅读全文