REST API 명세를 문서화하기

1. 명세

• 해당 API가 어떤 로직을 수행하는지 설명하고 이 로직을 수행하기 위해 어떤 값을 요청하며, 이에 따른 응답값으로는 무엇을 받을 수 있는지를 정리한 자료이다.
• API는 개발 과정에서느 계속 변경되므로 작성한 명세 문서도 주기적으로 업데이트가 필요하다. 이와 같은 문제를 해결하기 위해 등장한 것이 Swagger 라는 오픈소스 프로젝트이다.

 

2. Swagger 설정 코드

• http://localhost:8080/swagger-ui.html 로 접속하면 Swagger 페이지가 출력된다.