2017-10-18 4 views
1

Swagger API에 대한 재귀 적 사양을 만들고 싶습니다. 이 개념은 the Swagger documentation에없는 것으로 보이므로 가능한 것은 아닙니다. 그래서 Swagger가 지원하는 대안 솔루션에 대해서도 열려 있습니다.OpenAPI/Swagger에서 재귀 경로를 지정하는 방법

예를 들어 문서와 같은 구조를 만들려고합니다. 각 문서에는 섹션이 있으며 각 섹션에는 텍스트와 섹션이 있습니다. 이 같은 API 엔드 포인트있는에 계획입니다 :

정규식 스타일을 사용하여, 나는 API 사양이 같은 것을 사용하는 것이 :

...  
paths: 
    /docs/{document-id}: 
     get: 
      ... 
    /docs/{document-id}(/section/{section-id))+: 
     get: 
      ... 

그래서 질문은 다음과 같습니다

  1. 가 어떻게
  2. 인 자신감/OpenAPI를 사양에서 임의의 중첩 된 자원을 표시합니까 거기에 재귀 사양에 대한 필요성을 제거하는 대안 방법?
+0

현재 지원되지 않습니다. 이 문제는 관련이 있습니다. https://github.com/OAI/OpenAPI-Specification/issues/892 – Helen

답변

0

더 간단한 API 디자인을 권합니다. 일부 회사에서는 한도가 최대 2 개의 경로 매개 변수입니다. 더 많은 것은 유용성에 한계를두고 있습니다.

관련 문제