[Spring] Rest Docs로 API 문서를 관리해보자

백엔드 서버 개발을 하다보면 API 명세서를 관리할 일이 생깁니다. 누군가 우리의 서버 API 명세서를 보고 개발을 할 수도 있고, 추가적인 혹은 제거할 기능을 문서를 보고 결정하기도 합니다.

따라서 문서를 최신화하면서 관리해주는 것은 중요한데요. 오늘은 이 문서 관리를 할 수 있는 Rest Docs에 대해 알아보겠습니다.

Rest Docs 알아보기 전에 Swagger vs RestDocs 자바 진영에서 문서 관리할 수 있는 방법은 많지만, 크게 Swagger, Rest Docs 이렇게 두 가지를 많이 사용하는 것 같습니다. Rest Docs와 Swagger의 차이점을 한 번 간단하게 알아보고 Rest Docs 설명으로 넘어가도록 하겠습니다.

Swagger 스웨거는 위에 사진과 같이 어노테이션을 추가해주면서 문서를 만들어줄 수 있습니다. Rest Docs와 다르게 간단하게 어노테이션만 추가해주면 자동으로 문서가 생성되기 때문에 큰 시간을 들이지 않고 문서화를 할 수 있습니다.

하지만...