Wie Swagger 2.0 Textbeschreibungen formatieren?

Question

Ich möchte meine Swagger API-Beschreibungen formatieren, so dass sie keine einfachen Textabsätze sind. Am liebsten würde ich eine kleine Tabelle hinzufügen.

Ich habe keine Online-Referenz über Textformatierung in Swagger Beschreibungen gefunden. Wenn ich die Swagger Editor starten, und öffnen Sie das Beispiel Instagram (File \ Open Example \ Instagram.yaml), sehe ich das die erste Beschreibung in der YAML-Datei einige Formatierungen einschließlich eines Hyperlinks und Zeichen-Box zeigt:

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

Diese sieht aus wie Standard Markdown, aber wenn ich eine Tabelle Abschlags auf die Proben Beschreibung der Editor stellt einen Fehler hinzu:

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


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

Welche Formatierung hat Swagger 2.0 erlauben? Mache ich etwas falsch, um einen Tisch zu rendern?

Answer 1

Markdown ist in swagger-editor und folgende ist ein Beispiel unter Verwendung von Markdown in Prahlerei Dokument unterstützt:

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 

Sie können das obige Beispiel zu swagger-editor die Ausgabe sehen kopieren und einfügen.