3
Swagger UI를 사용하려고하는데 REST API에 대한 정확한 API를 설명하는 api-doc을 작성해야한다고 말합니다. 문제는 이것이 무엇을 의미하는지 전혀 모른다는 것입니다. 이 서류는 영어로 작성 되었습니까? 아니면 UI를 생성 할 수있는 특정 형식이 있습니까?Swagger 용 api-doc 작성하기
감사합니다.
A
답변
5
스레거는 REST API를 설명하기위한 사양입니다. 사양에 대한 문서는 https://github.com/swagger-api/swagger-spec에서 확인할 수 있습니다.
일반적으로 API를 문서화하는 데는 두 가지 방법이 있습니다. 이미 코드가있는 기존 API가있는 경우 런타임에 기존 라이브러리 (https://github.com/swagger-api/swagger-spec#additional-libraries)를 사용하여 코드에 통합하고 문서를 생성 할 수 있습니다. 이러한 라이브러리 중 일부는 오프라인 문서 생성 기능도 제공합니다.
API를 디자인하거나 다른 라이브러리를 응용 프로그램에 통합하지 않으려는 경우 https://github.com/swagger-api/swagger-editor을 로컬로 또는 온라인 버전 - http://editor.swagger.io과 함께 사용할 수 있습니다.
설명서가 있으면 Swagger UI를 사용하여 시각화하고 테스트 할 수 있습니다.