web-dev-qa-db-ja.com

Swagger 2.0のテキスト記述をフォーマットする方法は？

Swagger APIの説明をフォーマットして、テキストの単純な段落ではないようにします。できれば、小さなテーブルを追加したいと思います。

Swaggerの説明にテキストの書式設定に関するオンラインリファレンスが見つかりませんでした。 Swagger Editor を起動し、Instagramのサンプル（File\Open Example\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

Swagger 2.0で許可されているフォーマットは何ですか？テーブルをレンダリングするために何か間違ったことをしていますか？

restmarkdownswaggerswagger-2.0swagger-editor
28
TERACytE

マークダウンはSwagger Editorでサポートされています。以下は、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 | Collumn2 |
    | ------- | -------- |
    | cell1   | cell2    |
paths:
  /:
    get:
      responses:
        200:
          description: OK

上記の例をコピーして Swagger Editor に貼り付けると、出力を確認できます。

69
Wilson