18
swagger-ui 란 무엇이며 어떻게 사용합니까?swagger-ui 시작 방법
swagger-ui를 시작하기에 좋은 자료가 있습니까? 좋은 튜토리얼, 블로그 또는 도서?
나는 또한 http://swagger.io/을 요구하지만 나는 더 많은 정보가 필요하다.
나를 안내 해주세요. 감사합니다.
A
답변
15
Swagger UI는 Swagger 사양 파일을 시각적으로 표시하고 작업을 실행할 수있게 해주는 도구입니다.
스 거거 자체는 REST API를 문서화하고 설명하기위한 사양입니다. 사양은 여기에서 찾을 수 있습니다 - https://github.com/swagger-api/swagger-spec/. 저장소에는 사양 자체, json 스키마, 샘플 등이 포함됩니다. 저장소의 주요 README는 또한 사용자의 스펙을 생성하는 라이브러리 및 프레임 워크를 포함하는 추가 도구를 가리 킵니다.
Swagger 사양을 만들 때 프레임 워크 중 하나를 사용하고 기존 코드와 통합하여 이러한 문서를 자동 생성 할 수 있습니다.
기존 응용 프로그램이 없거나 수동으로 문서화하려는 경우 Swagger-Editor 도구 또는 원하는 텍스트 편집기를 사용할 수 있습니다.
감사합니다 webron, swagger에 대한 명확한 그림을 제공 할 수 있습니다. –
기존 Swagger API를 실행하고 있습니다. 이제 Swagger UI가 내 API 문서를 표시하는 데 필요한 것은 무엇입니까? './dist/index.html' 파일을 열어 내 swagger api로 이동해도 꽤 잘리는 것은 아닙니다. http를 통해 수동으로 'swagger.json'을 제공해야합니까? 내 API에 .json 파일 만 제공하는 추가 엔드 포인트가 필요합니까? 명확히 해 주셔서 감사합니다. – atripes
질문이 불분명하고 세부 사항이 부족합니다. 나는 여기에서 전체 세부 사항으로 새로운 질문을 시작하거나 더 밀접하게 모니터되는 우리의 구글 그룹을 사용할 것을 제안 할 것이다. – Ron