2016-10-07 2 views
14

Swagger API 설명을 간단한 단락이 아니도록 서식을 지정하고 싶습니다. 가급적이면 작은 테이블을 추가하고 싶습니다.Swagger 2.0 텍스트 설명을 포맷하는 방법은 무엇입니까?

Swagger 설명에서 텍스트 서식에 대한 온라인 참조를 찾지 못했습니다.

[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.yaml)를 열면, 나는 YAML 파일의 첫 번째 설명이 하이퍼 링크 및 경계 상자를 포함한 일부 서식을 보여줍니다 참조 표준 Markdown처럼 보이지만 내가 샘플 설명에 테이블 인하를 추가 할 때, 에디터는 오류 제공 :

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


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

자신감 2.0은 어떤 형식을 허용 않습니다를? 테이블을 렌더링하는 데 문제가 있습니까?

답변

31

마크 다운은 swagger-editor에지지되고 후속하는 자신감 문서 마크 다운을 사용하는 예이다

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 위 예를 붙일 수는.

+1

아. 나는 이유를 안다. YAML은 들여 쓰기에 민감합니다. 나는 그것을 올바르게하지 않았다. 고맙습니다. – TERACytE

+0

@ 윌슨 (Shilson)은 정보 섹션에만 제한된이 마크 다운 지원입니까? 애완 동물 개체에 대한 설명으로 복사/붙여 넣기 할 때 정보 섹션에 삽입 할 때와 동일하게 나타나지 않습니다. 감사! –

+0

@ @ Stephen McFarland - 설명에 "|"이 있어야합니다. 첫 번째 줄로 입력하고 설명에서 원하는 텍스트를 들여 쓰기해야합니다. 50 명의 담당자가 아직 없으므로 죄송합니다. _ [fallenprogrammr] (https://stackoverflow.com/users/438546/fallenprogrammr)의 답변으로 게시됩니다. 그들의 "대답"이 제거되기 전에 나는 좋을 것이고 메시지를 전달할 것이라고 생각했다. – Bugs

관련 문제