<aside> 😊 Swagger의 정의와 기능 장점 종류 등등을 정리해서 모아놓은 페이지입니다 :)
</aside>
Swagger
개발자가 REST API 서비스를 설계, 빌드, 문서화할 수 있도록 하는 프로젝트
Swagger가 유용하게 사용되는 경우
- 다른 개발팀과 협업을 진행 할 경우
- 이미 구축되어있는 프로젝트에 대한 유지보수를 진행할 경우
- 백엔드의 API를 호출하는 프론트엔드 프로그램을 제작할 경우
Swagger 기능
- API 디자인
- API 빌드
- API 문서화
- API 테스팅
- API 표준화
Swagger 장점
- API 정보 현행화 가능
- API를 통해 Parameter, 응답 정보, 예제 등 Spec 정보 전달이 용이함
- 실제 사용되는 Parameter로 테스트 가능
Swagger Tool 종류
- Swagger Codegen
Swagger로 정의된대로 클라이언트/서버 코드를 생성하는 CLI툴
- Swagger UI
SWagger API 명세서를 HTML형식으로 확인할 수 있는 툴
- Swagger Editor
Swagger 표준에 따른 API 설계서 / 명세서를 작성하기 위한 에디터