일반적으로 여러명이서 개발하는 웹 서비스에서 단일 프로젝트가 DB에서 데이터를 가져오고, 화면을 그려주고, 회원정보를 저장하는 등 모든 것을 담당하진 않는다. 아무리 간단한 구조라해도 아래와 같은 형태정도는 유지한다.

(웹구조)
이런 구조로 처음 개발하거나 혹은 유지보수를 진행 중인 경우, 해당 API서버가 어떤 Spce을 가진 데이터를 주고 받는지에 대한 문서작업이 꼭 필요하다.
하지만 이런 문서작업은 굉장히 시간이 많이들고, 매번 기능이 추가되거나 변경될때마다 작업하기가 여간 귀찮은게 아니다. 그러다보니 이런 API Spec 문서를 자동화 하는 것이 나오게 되었다.
Swagger는 간단한 설정으로 ****프로젝트에서 지정한 URL들을 HTML화면으로 확인할 수 있게 해주는 프로젝트이다. 백마디 말보다는 실제 화면을 보는 것이 좋다.
⇒ SSAFY에서 진행한 공통 프로젝트에서 사용한 코드를 예시로 하였습니다.
설정하는 방법은 Sprign Boot & Maven을 기반으로 하고 있습니다.