3-1. 스웨거에 대한 조사

[00kang]

스웨거에 대한 조사

• 스웨거는 WEB API 문서화를 위한 도구이다.
• 스웨거 홈페이지에서는 스웨거를 OAS(Open API Specification)이라고 소개하고 있다.
• 말 그대로 API들이 가지는 명세(Spec)을 관리하기 위한 프로젝트이다.

  백 엔드 프로그램과 프론트 엔드 프로그램 사이에서 정확히 어떠한 방식으로 데이터를 구조 받을 지에 대한 명세가 필요할 수 있습니다. 이러한 내용이 담긴 문서를 일반적으로 API 명세서라고 한다. 문서 출처

• Web API를 수동으로 문서화 하는 것은 굉장히 힘든일인데, Web API의 스펙이 변경되었을 때 문서 역시 변경되어야 하는데 이를 유지하는 것이 쉽지 않다. Swagger를 사용하면 Web API가 수정되더라도 문서가 자동으로 갱신 되기 때문에 편리하다.
• 문서 출처

RealWorld Swagger

RealWorld Swagger 홈페이지