REST API에 대한 설명서
Swagger를 이용한 REST API 문서화
프로젝트 개발 시 일반적으로 프론트엔드 개발자와 백엔드 개발자가 분리
프론트 엔드 개발자의 경우 화면에 집중하고 백엔드 개발자가 만든 문서 API를 보며 데이터 처리 를 하게 된다.
이 때 개발 상황의 변화에 따른 API의 추가 또는 변경할 때 마다 문서에 적용하는 불편함 발생
이 문제를 해결하기 위해 Swagger를 사용
API 문서를 자동으로 만들어준다.
Swagger
기존 문서로 사용하던 문제를 해결하기 위해 Swagger를 사용
간단한 설정으로 프로젝트의 API 목록을 웹에서 확인 및 테스트 할 수 있게 해주는 라이브러리
Swagger를 사용하면 Controller에 정의되어 있는 모든 URL을 바로 확인할 수 있다.
API 목록 뿐 아니라
설정
pom.xml에 swagger dependency 추가
1. swagger-ui(SpringFox Swagger UI)
2. swagger2(SpringFox Swagger2)
