Spring Restful API 문서화

이 글은 Spring 기반 Restful API의 문서화 방법에 대해 설명합니다. 초기에는 Word 문서나 RAML을 사용하여 API 문서를 관리했지만, RAML은 별도의 문법 학습과 HTML 수동 재생성의 번거로움이 있었습니다.

이러한 문제를 해결하기 위해 Spring 진영에서는 Springfox-Swagger2를 도입하여 API 문서를 자동으로 생성하는 방법을 소개합니다. gradle에 dependency를 추가하고, Java Config 클래스에서 Docket Bean을 설정하며, Controller 클래스에 @Api, @ApiOperation 어노테이션을 작성하는 구체적인 예제를 통해 Springfox-Swagger2를 활용한 API 문서화 방법을 안내합니다.

안내합니다.