swagger @Example使用案例
时间: 2023-07-20 13:14:18 浏览: 142
Swagger @Example可以用来定义API的示例值,方便开发人员查看和调试。下面是一个使用Swagger @Example的例子:
```yaml
paths:
/users:
post:
summary: Create a user
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
age:
type: integer
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example:
id: 123
```
在上面的例子中,我们定义了一个POST请求用于创建用户。请求体中包含了名字和年龄两个参数,而响应中只返回了一个ID。使用Swagger @Example,我们可以为响应中的ID字段提供一个示例值,这样开发人员在查看API文档时就能更清楚地了解API的使用方法和返回结果。