1
내 사이트의 공개 API가 자동으로 검색 될 수 있도록 swagger.json (또는 동의하는 이름)을 지정해야하는 URL에 대한 사양이나 규칙이 있습니까?OpenAPI 또는 swagger.json 자동 검색
A
답변
2
업데이트 19 April 2017 : 이전에 준 OpenAPI Wiki 응답은 "for a very very very old version of the spec"입니다. 동일한 출처에 따르면 2.0의 경우 표준은 swagger.json이고 3.0의 경우는 openapi.json으로 변경됩니다.
원래 답 :
OpenAPI를 위키 recommends 서버 API에 대한 도 종
/api-docs엔드 포인트를 사용하여. 나는 야생에서 여러 사이트를 보았습니다. 그 사이트는 이며, 우리 가게 표준입니다.
희망이 있습니다.
+0
https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md# 파일 구조는 파일 이름이'openapi.json' 또는'openapi.yaml'이어야한다고 말합니다. –
+0
@anatolytechtonik 감사합니다. 나는 고쳐졌다. 답변을 수정할 것입니다. –
+0
좋아 보인다. =)하지만 .. 여전히 답을주지는 못합니다. ** 어디서 파일을 읽어야하고 어디에서 읽을 수 있는지 알아야합니까? –
0
URL에 대한 OPTIONS 요청에 대한 응답으로 HTTP 응답 본문에서 Swagger JSON을 제공하는 것은 어떻습니까?
이것은 특히 relevant RFC에서 허용됩니다.
또한 HATEOAS 구현을 고려하여 strongly advocated by Roy Fielding으로 지정하십시오.
나는 알고 있습니다. 국제 대회가 OpenAPI/Swagger 생태계에 유용하기 때문에 https://github.com/OAI/OpenAPI-Specification/issues를 통해 제안을 제출해주십시오. –
@ wing328, 완료 - https://github.com/OAI/OpenAPI-Specification/issues/864 –