swagger怎么添加请求示例

Swagger是一个用于API文档生成和交互的设计工具，它可以帮助开发者更好地设计、描述和测试RESTful API。要向Swagger添加请求示例，通常是在API的定义里，你可以按照以下步骤操作：

1. **定义API**：
- 在`paths`部分找到你要添加请求示例的路径，比如`/users/{id}`。
- 对于该路径，创建一个新的`get`、`post`、`put`或`delete`等方法。

2. **添加请求体**：
- 如果你的请求需要一个请求体（例如POST或PUT），在`requestBody`标签下定义数据模型（如JSON schema）。例如：

     parameters:
       - name: user
         in: body
         required: true
         schema:
           $ref: '#/components/schemas/User'

- 使用`#/components/schemas/`引用已定义的数据模型。

3. **编写示例**：
- 在`responses`部分的对应HTTP状态码下，添加一个`example`标签来提供一个具体的请求示例。例如：

     responses:
       '200':
         description: User details retrieved successfully
         content:
           application/json:
             example:
               {
                 "id": 1,
                 "name": "John Doe",
                 "email": "john.doe@example.com"
               }

4. **保存并生成文档**：
- 保存你的Swagger配置文件（通常是`.yaml`或`.json`），然后使用Swagger UI或者在线编辑工具（如ReDoc）查看更新后的文档，你会看到请求示例已经添加到对应的API描述中。