Swagger는 REST API 개발을 지원하는 오픈 소스 프레임워크입니다.
API 개발을 위해 설계, 빌드, 테스트, 문서 등 다양한 기능을 지원합니다.

그중에서 Swagger UI를 통한 API 문서는 가장 많이 사용됩니다.
개발자가 별도 API 명세 페이지를 작성 할 필요 없이 자동으로 정보를 제공합니다.

의존성

build.gradle

implementation 'io.springfox:springfox-swagger2:3.0.0'
implementation 'io.springfox:springfox-swagger-ui:3.0.0'

기본 경로

swagger-ui 3.x 이상

http://localhost:8080/swagger-ui/index.html

swagger-ui 3.x 미만

http://localhost:8080/swagger-ui.html

경로 수정

application.properties

springfox.documentation.swagger.v2.path=/api
springfox.documentation.swagger-ui.base-url=/api