如何格式化 Swagger 2.0 文本描述?
How to format Swagger 2.0 text descriptions?
我想格式化我的 Swagger API 描述,使它们不是简单的文本段落。最好,我想给它添加一个小 table。
我没有找到关于 Swagger 描述中文本格式的在线参考。如果我启动 Swagger Editor,并打开 Instagram 示例(文件\打开示例\Instagram.yaml),我会看到 yaml 文件中的第一个描述显示了一些格式,包括超链接和边界框:
[registered your client](http://instagram.com/developer/register/) it's easy
to start requesting data from Instagram.
```
https://api.instagram.com/v1/media/popular?client_id=CLIENT-ID
```
这看起来像标准 Markdown,但是当我向样本描述添加 table 降价时,编辑器出现错误:
|Col1|Col2|
|------|------|
|1|2|
YAML Syntax Error
End of the stream or a document separator is expected at line 36, column
Swagger 2.0 允许什么格式?
我在渲染 table 时做错了什么吗?
Swagger 编辑器支持 Markdown。下面是在 OpenAPI (Swagger) 文档中使用 Markdown 的示例:
swagger: '2.0'
info:
version: 0.0.0
title: Markdown
description: |
# Heading
Text attributes _italic_, *italic*, __bold__, **bold**, `monospace`.
Horizontal rule:
---
Bullet list:
* apples
* oranges
* pears
Numbered list:
1. apples
2. oranges
3. pears
A [link](http://example.com).
An image:
![Swagger logo](https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/favicon-32x32.png)
Code block:
```
{
"message": "Hello, world!"
}
```
Tables:
| Column1 | Column2 |
| ------- | --------|
| cell1 | cell2 |
paths:
/:
get:
responses:
200:
description: OK
您可以将上面的示例复制并粘贴到 Swagger Editor 以查看输出。
我想格式化我的 Swagger API 描述,使它们不是简单的文本段落。最好,我想给它添加一个小 table。
我没有找到关于 Swagger 描述中文本格式的在线参考。如果我启动 Swagger Editor,并打开 Instagram 示例(文件\打开示例\Instagram.yaml),我会看到 yaml 文件中的第一个描述显示了一些格式,包括超链接和边界框:
[registered your client](http://instagram.com/developer/register/) it's easy
to start requesting data from Instagram.
```
https://api.instagram.com/v1/media/popular?client_id=CLIENT-ID
```
这看起来像标准 Markdown,但是当我向样本描述添加 table 降价时,编辑器出现错误:
|Col1|Col2|
|------|------|
|1|2|
YAML Syntax Error
End of the stream or a document separator is expected at line 36, column
Swagger 2.0 允许什么格式? 我在渲染 table 时做错了什么吗?
Swagger 编辑器支持 Markdown。下面是在 OpenAPI (Swagger) 文档中使用 Markdown 的示例:
swagger: '2.0'
info:
version: 0.0.0
title: Markdown
description: |
# Heading
Text attributes _italic_, *italic*, __bold__, **bold**, `monospace`.
Horizontal rule:
---
Bullet list:
* apples
* oranges
* pears
Numbered list:
1. apples
2. oranges
3. pears
A [link](http://example.com).
An image:
![Swagger logo](https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/favicon-32x32.png)
Code block:
```
{
"message": "Hello, world!"
}
```
Tables:
| Column1 | Column2 |
| ------- | --------|
| cell1 | cell2 |
paths:
/:
get:
responses:
200:
description: OK
您可以将上面的示例复制并粘贴到 Swagger Editor 以查看输出。