swagger中返回值result如何展示换行
时间: 2024-09-12 08:06:45 浏览: 57
swagger中文bug的js补丁
3星 · 编辑精心推荐
在Swagger (一个流行的API文档生成工具) 中,当你定义RESTful API的返回结果时,如果你的返回值是一个包含换行的字符串,你可以将其放在一个描述性的字段中,并使用特殊的格式标记来表达换行。例如,假设你有一个返回的是多行文本的API,你可以这样定义:
```yaml
/get/my-data:
get:
description: 获取多行数据
responses:
'200':
description: 成功获取数据
content:
application/json:
schema:
type: object
properties:
result:
type: string
example:
```
这是一行示例
这是第二行
```
```
在这个例子中,`example`部分展示了预期的返回结果,三连反引号(````)包围的内容会被解析为预格式化文本,包括换行。
阅读全文