Comment formater les descriptions de texte Swagger 2.0?

Je voudrais formater mon Swagger API descriptions de sorte qu'ils ne sont pas de simples paragraphes de texte. De préférence, j'aimerais ajouter une petite table.

Je n'ai pas trouver une référence à propos de la mise en forme du texte dans Swagger descriptions. Si je lance le Swagger Éditeuret ouvrir la Instagram exemple (Fichier \ Ouvrir un Exemple \ Instagram.yaml), je vois la première description dans le fichier yaml montre une certaine mise en forme, y compris un lien hypertexte et de la boîte englobante:

    [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
```

Cela ressemble à la norme De démarquemais quand j'ajoute un tableau de markdown pour les échantillons de la description, l'éditeur présente une erreur:

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


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

Ce que le formatage ne Swagger 2.0?
Suis-je en train de faire quelque chose de mal pour rendre un tableau?

source d'informationauteur TERACytE | 2016-10-07

  1. 38

    Markdown est pris en charge dans swagger-editor et qui suit est un exemple d'utilisation de Markdown à swagger document:

    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

    Vous pouvez copier et coller l'exemple ci-dessus pour swagger-éditeur pour voir le résultat.