如何格式化Swagger 2.0文本描述？

我想格式化我的Swagger API描述，以便它们不是简单的文本段落。最好，我想添加一个小桌子。如何格式化Swagger 2.0文本描述？

我没有找到有关扬鞭描述文本格式的在线参考。如果我启动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，但是当我添加一个表以降价的样本描述，编辑器显示错误：

|Col1|Col2| 
|------|------| 
|1|2| 


YAML Syntax Error 
End of the stream or a document separator is expected at line 36, column

什么格式不扬鞭2.0允许？我是否做错了呈现表？

来源

2016-10-07 TERACytE

降价是swagger-editor支持，以下是招摇文档中使用降价的例子：

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). 

    Tables: 

    | Column1 | Collumn2 | 
    | ------- | -------- | 
    | cell1 | cell2 | 
paths: 
    /: 
    get: 
     responses: 
     200: 
      description: OK

您可以复制和上面的例子粘贴到swagger-editor查看输出。

来源

2016-10-08 05:42:22 Wilson

啊。我知道为什么。 YAML对缩进很敏感。我没有做正确的。 Thanx Wilson。 – TERACytE

@威尔逊，这种降价支持仅限于信息部分？当我复制/粘贴这个对象作为Pet对象的描述时，它看起来不像它插入到info部分的时候。谢谢！ –

_ @ Stephen McFarland - 描述应该有“|”作为第一行，并且在描述中需要的文本应该缩进。对不起，我无法评论，因为我没有50个代表。[发布时间] [回复：[fallenprogrammr]（https://stackoverflow.com/users/438546/fallenprogrammr））。以为我会很好，并在他们的“答案”被删除之前传递消息。 – Bugs

如何格式化Swagger 2.0文本描述？

回答

相关问题