2016-10-07 7 views
14

私はSwagger API記述をテキストの単なる段落にならないように書式化したいと思います。好ましくは、私はそれに小さなテーブルを追加したいと思います。Swagger 2.0のテキスト記述のフォーマット方法は?

Swaggerの説明でテキストフォーマットに関するオンラインリファレンスが見つかりませんでした。私は(\オープン例\ Instagram.yamlファイル)Swagger Editorを起動し、Instagramの例を開くと、私は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は、どのような書式設定を許可していますか? テーブルをレンダリングするのに間違っていますか?

答えて

31

値下げが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に上記の例をコピーして貼り付けることができます。

+1

Ah。なぜだか知っているよ。 YAMLはインデントに敏感です。私はそれを正しくしなかった。サンクスウィルソン – TERACytE

+0

@Wilson、このマークダウンサポートはInfoセクションのみに限定されていますか? これをペットオブジェクトの説明としてコピー/ペーストすると、infoセクションに挿入されたときと同じように表示されません。ありがとう! –

+0

@ @ Stephen McFarland - 説明には "|"その最初の行として、そしてあなたが記述に入れたいテキストをインデントする必要があります。申し訳ありませんが、まだ50人の担当者がいないためコメントできませんでした._ [fallenprogrammr](https://stackoverflow.com/users/438546/fallenprogrammr)の回答として投稿しています。彼らの "答え"が削除される前に、私は素敵でメッセージを伝えると思っていました。 – Bugs

関連する問題