1. 의존성 설정
만약 특정 구성만 사용해야 하는 경우는 각각의 구성에 대한 의존성을 추가하면 된다.
간단하게
springfox-boot-starter
하나 추가로 필요한 모든 라이브러리 포함 가능하다.
implementation 'io.springfox:springfox-boot-starter:3.0.0'
주요 구성은 다음과 같다.
SpringFox Swagger 2
는 적용된 프로젝트의 응답, 요청, 예시 등의 정보를 JSON 쌍으로 만들어준다.
SpringFox UI
는 Swagger 2를 통해 만든 JSON 쌍을 상호작용하기 좋은 웹페이지로 만들어준다.
SpringFox Bean Validator
를 적용할 경우, Swagger가 문서화를 진행하면서 Bean Validation Annotation이 적용된 내용에 대한 정보를 추가로 저장한다.
SpringFox Data REST
는 @Entity와 @Repository를 찾아 엔티티에 대한 사양 정보를 추가로 문서화한다.
추가 설정없이 의존성만 추가하고 어플리케이션을 실행한 후
http://server
:port/context-path/swagger-ui.html(ex.
http://localhost:8080/**swagger-ui.html**
) 로 접속 해본다. 기본 설정을 바탕으로 swagger UI화면을 볼 수 있다.
추가적으로 **
http://localhost:8080/v3/api-docs**를
입력하면 json 형식의 api doc정보를 확인할 수 있고, **
http://localhost:8080/v3/api-docs.yaml**을
입력하면 yaml형식으로도 아래와 같이 확인이 가능하다.
2.
SwaggerConfig.java