2012-09-10 4 views
0

저는 swagger UI를 다운로드하여 로컬에서 실험했습니다. "path", "body"및 "query"와 같은 시나리오에서는 잘 작동합니다. 하지만 대부분의 유스 케이스에서는 휴식 코멘트를 사용합니다.Swagger에서 REST 주석을 사용할 수 없습니다.

즉/resourcePath /; 특정 리소스의 태그를 검색하는 태그 URI.

내가 이것을 시도하면 세미 콜론을 추가 할 때 UI가 뒤죽박죽이되어 정렬 된 UI를 조작 할 수 없으며이를 넘어 설 수 없습니다.

알려진 제한 사항이 있습니까? 이 목표를 달성하기위한 해결 방법이 있습니까? 이 어떤 입력을 감사합니다 ..

+1

안녕하세요. 고맙습니다. 이제 완료되었습니다. 사실 나는 잠시 동안 대답을 받아들이지 않았다. –

답변

1

자신감은 같은 {tags} 및 쿼리 PARAMS처럼 곱슬 괄호 path PARAMS을 지정하는 기대 쉼표로 구분 등 id=1,2,3,4로. 일부 프레임 워크에서는 세미콜론을 구분 기호로 사용하지만 swagger는 쉼표를 선호합니다.

더 구체적인 예를 들어 더 많은 것을 설명 할 수 있습니까? 디자인에 따라 API에 대한 설명은 운영을 위해 descriptionnotes 필드에 속하므로 자세한 내용은 swagger-core wiki을 참조하십시오.

Swagger codegen 프로젝트에는 사양이 올바른지 확인하는 데 사용할 수있는 유효성 검사기가 있습니다.

+0

빠른 응답을 보내 주셔서 감사합니다. 간단한 예를 들어 보겠습니다. 즉 /local/node1;rating:4.5이며 이는 4.5의 등급을/local/node1의 노드에 제공합니다. 자세한 내용은 [1] [1] - http://tools.ietf.org/html/rfc3986#page-23을 참조하십시오. 우리가 그렇게 할 때 문제가되는 것은, 스 태거 UI가 뒤죽박죽이되어 진행할 수 없기 때문입니다. 우리가 비틀 거리며 이것을 성취 할 수있는 방법이 있습니까? 어떤 도움을 주시면 감사하겠습니다. –

관련 문제