Swagger 기초

Swagger 란?

Swagger는 대표적인 API 관리 도구이다.

특정한 프로그램에 존재하는 API의 기능을 명세하고, API의 기능을 바로 테스트할 수 있도록 도와주는 도구이다. 

 

모든 개발자는 이러한 API 관리 도구에 대해 알아야 한다. 팀 단위로 개발을 진행하고 다양한 개발자(서버와 클라이언트) 개발을 할 때 필수적이다. 

 

기본적으로 REST API를 채택하고, 서비스를 마이크로하게 개발하는 구조와 잘 어울린다.

스웨거는 yaml 형식을 지원한다.

 

API 명세서에는 API를 어떻게 이용하는지, 어떤 파라미터를 담아서 전송하면 되는지 등이 문서형태로 작성되어 있다.

Swagger Hub

스웨거 허브를 통해 스웨거 기능을 제공하고 있다. 

API 명세서를 작성하는 것은 귀찮은 작업이지만, 스웨거 허브에서 다양한 기능을 제공하고 있어서 그나마 간편하게 명세서를 작성할 수 있다.

 

 

OpenAPI

REST API를 위한 표준 API 명세 규격. 즉, API 명세를 어떻게 작성하면 되는지 정해놓은 것

yaml 형식, json 형식을 지원한다.

 

---

https://youtu.be/akbdsrOpQ60