Swagger란
API를 설계하고 문서화 하는데 도움을 주는 기술
공식 링크
사용 이유
- 기존 API 문서는 형식이 다양했음.
=> Git , Google Docs , Wiki , Json 등
=> Server에 연결시 , Swagger 가 자동으로 HTML 화면으로 변환해 보여준다.- 유지 보수가 용이함.
- Frontend 개발자가 파악하기 쉽다.
Swagger 사용법
- paths : 경로 지정
- get : Request 방식
- response : 응답 상태 지정
- parameters : API 실행에 필요한 parameter 넣음
- openapi : openapi version
- info : 각종 정보 포함
- servers : 연결할 server url 지정
- apis : api 문서화 할 routing function이 있는 경로 지정
