स्वैगर 2.0 टेक्स्ट विवरण कैसे प्रारूपित करें?

Question

मैं अपने स्वैगर एपीआई विवरणों को प्रारूपित करना चाहता हूं ताकि वे टेक्स्ट के साधारण पैराग्राफ न हों। अधिमानतः, मैं इसमें एक छोटी सी टेबल जोड़ना चाहता हूं।

मुझे स्वैगर विवरणों में टेक्स्ट स्वरूपण के बारे में ऑनलाइन संदर्भ नहीं मिला।

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

यह: यदि मैं Swagger Editor लॉन्च करते हैं, और Instagram उदाहरण (फ़ाइल \ ओपन उदाहरण \ Instagram.yaml) खोलने के लिए, मैं YAML फ़ाइल में पहली वर्णन एक हाइपरलिंक और बाउंडिंग बॉक्स सहित कुछ स्वरूपण से पता चलता देखना मानक Markdown की तरह दिखता है, लेकिन जब मैं नमूने वर्णन करने के लिए एक मेज markdown जोड़ने के लिए, संपादक एक त्रुटि प्रस्तुत करता है:

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


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

स्वैगर 2.0 क्या स्वरूपण अनुमति देता है? क्या मैं टेबल प्रस्तुत करने में कुछ गलत कर रहा हूं?

Answer 1

Markdown swagger-editor में समर्थित है और निम्नलिखित अकड़ दस्तावेज़ में 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). 

    Tables: 

    | Column1 | Collumn2 | 
    | ------- | -------- | 
    | cell1 | cell2 | 
paths: 
    /: 
    get: 
     responses: 
     200: 
      description: OK 

आप कॉपी और swagger-editor के ऊपर के उदाहरण पेस्ट उत्पादन को देखने के लिए कर सकते हैं।