스웨거 (Swagger)란?
- 스웨거는 Web API 문서화를 위한 도구이다.
- 스웨거 홈페이지에서는 스웨거를
OAS(Open API Specification)이라고 소개하고 있다. - 말 그대로 API들이 가지는 명세(Spec)을 관리하기 위한 프로젝트이다.
- Web API를 수동으로 문서화 하는 것은 굉장히 힘든일인데, Web API의 스펙이 변경되었을 때 문서 역시 변경되어야 하는데 이를 유지하는 것이 쉽지 않다.
- Swagger를 사용하면 Web API가 수정되더라도 문서가 자동으로 갱신 되기 때문에 편리하다.
스웨거의 기능
스웨거 홈페이지를 가보면 아래와 같은 기능이 있다.
- API Design
- API Development
- API Testing
- API Mocking and Virtualization
- API Governance
- API Monitoring
- OpenAPI & Swagger
Web API를 이용하는 개발자가 Web API가 만들어질 때까지 기다린다면 작업이 상당히 느려질 수 있다. Web API를 만드는 개발자와 Web API를 사용하는 사람 간에 미리 명세를 정의하고 공유할 수 있다면 개발이 상당히 편리해질 것이다. 이러한 것들을 편리하게 해주는 도구 중에 하나가 "스웨거"이다.
스웨거 허브를 이용하여 API를 명세화하고 테스트하기
스웨거 허브 사이트를 이용하면 Web API를 만들지 않더라도 Web API를 명세화 할 수 있다. 또한 Web API를 명세화 하는것 뿐 아니라 간단히 테스트도 할 수 있다는 장점이 있다.
참조 URL
'Java > Spring' 카테고리의 다른 글
pom.xml (0) | 2020.07.11 |
---|---|
Maven이란? (0) | 2020.07.10 |
Rest Controller란? (0) | 2020.07.01 |
Post 방식으로 데이터 전송시 한글이 깨지는 문제 (0) | 2020.06.30 |
Spring Error (0) | 2020.06.30 |