Swagger를 활용한 API 명세와 개발 협업

Swagger

API 문서를 자동으로 시각화해주는 툴

---

1️⃣ 장점

• 문서 자체에 API 테스트 환경 구축
• API 명세와 테스트를 한번에 쉽고 빠르게 할 수 있다.
• OpenAPI 규격에 맞게 API에 대한 정보를 실시간으로 업데이트 한다.

 

> 스웨거 허브 (Swagger Hub) : https://swagger.io/tools/swaggerhub/

 

 

2️⃣ 사용 방법

1. 특정 프로그래밍 언어를 이용해서 Swagger API를 종속적으로 이용 (ex.Spring)
2. yaml 파일 or json 파일로 독립적으로 명세하는 방법

 

3️⃣ NodeJS + Express에서 사용

 

우리 팀은 json파일로 swagger를 정의했다.