Swagger 문서를 사용하여 웹 사이트에 API 문서 추가

Question

기본 웹 페이지가 있고 API의 Swagger 문서 JSON 파일이 있습니다. 문서를 웹 사이트에 실제로 추가하여 탐색 할 수있는 방법을 확신하지 못합니다.

API에 대한 호스트 된 문서를 만들고 싶습니다. http://petstore.swagger.wordnik.com/#!/pet/addPet

난 그냥 자신감 UI를 다운로드하고 JSON 파일과 함께 사용 마십시오

이

는 자신감에 의해 주어진 예이다.

그러나 이것을 달성하기는 어렵습니다. 이와 같은 것을 만드는 방법에 대한 조언은 매우 유용 할 것입니다.

Answer 1

기본적으로 Swagger-ui는 API를 표시하기 위해 서버에서 호스트 할 수있는 정적 파일 세트입니다.

중요한 변경 사항이 없으면/dist 폴더의 내용을 서버에 복사하고 응용 프로그램의 일부로 호스트해야합니다 (또는 정적 웹 사이트는 중요하지 않음).

SwaggerUi 개체는 호스팅중인 사양의 URL을 포함하여 필요에 맞게 사용자 지정할 수 있습니다.

ui와 spec을 동일한 서버 (즉, 동일한 호스트와 동일한 포트)에 호스트하지 않는 경우 CORS을 사용하도록 설정해야합니다.