Swagger 2.0 metin açıklamaları nasıl biçimlendirilir?

Question

Swagger API açıklamalarımı basit bir metin paragrafları olmayacak şekilde biçimlendirmek istiyorum. Tercihen, ona küçük bir masa eklemek isterim.

Metin biçimlendirme hakkında Swagger açıklamalarında çevrimiçi bir başvuru bulamadım.

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

Bu: Ben Swagger Editor başlatmak ve Instagram örneği (Dosya \ Aç Örnek \ Instagram.yaml) açarsanız, ben yaml dosyasındaki ilk açıklama köprü ve sınırlayıcı kutusu dahil bazı biçimlendirme gösterir bkz standart Markdown gibi görünüyor, ama ben numuneler açıklamaya bir tablo fiyat indirimlerini eklerken, editör bir hata sunar:

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


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

Swagger 2.0 ne biçimlendirme izin veriyor? Tablo oluşturmak için yanlış bir şey yapıyorum?

Answer 1

Markdown swagger-editor desteklenir ve aşağıdaki bir dayı belgesinde Markdown kullanarak örnektir:

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 

kopyalayabilir ve çıkış görmek swagger-editor yukarıdaki örneği yapıştırabilirsiniz.