API Blueprint 매개 변수 이름이 표시되지 않습니다.

API 청사진에 익숙하지 않으므로 여기에 제발 애원 해주세요. 나는 같은 Aglio 예에 주어진 몇 가지 매개 변수의 형식을 시도하고있다 :API Blueprint 매개 변수 이름이 표시되지 않습니다.

+ Parameters 

    + name (optional, string, `alice`) ... Search for a user by name 
    + joinedBefore (optional, string, `2011-01-01`) ... Search by join date 
    + joinedAfter (optional, string, `2011-01-01`) ... Search by join date

그러나, 매개 변수의 이름을 표시하고 모든 매개 변수의 인덱스입니다. 다음은 Atom API 디스플레이 패키지의 디스플레이입니다 : https://atom.io/packages/api-blueprint-preview.

enter image description here

어떻게 그것을 매개 변수의 이름을 표시 할 수 있습니까?

출처

2014-06-18 Nathaniel Wendt

청사진 스 니펫이 정상적으로 보입니다. 단지 - 각 리소스를 정의하는 데 사용 된 URI 템플릿을 공유 할 수 있습니까? URI 템플릿에는 다음과 같은 내용이 포함되어야합니다.

# Resource [/resource{?name,joinedBefore,joinedAfter}]

하지만 청사진은 괜찮아 보이므로 Aglio 또는 미리보기 패키지 자체에 문제가 될 수 있습니다. 확인하고보고하는 것이 가장 좋은 방법은 https://github.com/danielgtaylor/aglio/issues?state=open 또는 https://github.com/danielgtaylor/atom-api-blueprint-preview/issues입니다.

출처

2014-06-19 08:31:33 Zdenek

URI 템플릿을 표시하는 방법을 모르는 경우 어떻게 찾을 수 있습니까? –

"표시 할"항목 - URI 템플릿은 리소스 섹션 정의의 일부입니다. - https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#def-resource -섹션 – Zdenek

API Blueprint 매개 변수 이름이 표시되지 않습니다.

답변

관련 문제