스웨거는 백엔드에서 개발한 API를 문서화해주는 툴로 개발 진행중일 때 뿐만아니라 운영중에도 유용하게 사용되기도 하는데요
스웨거 버전이 3으로 올라가면서 설정 및 기본 url이 변경이 되었습니다.
스웨거 버전 업에 두어번 실패한 끝에 가장 간단히 해결할 수 있는 방법을 구해왔습니다.
버전은 스프링부트 2.4.0, 스웨거 3.0.0 입니다.
메이븐프로젝트
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
그래들 프로젝트
repositories {
jcenter()
}
dependencies {
implementation "io.springfox:springfox-boot-starter:3.0.0"
implementation "io.springfox:springfox-swagger-ui:3.0.0"
}
SwaggerConfig 클래스를 하나 만들어서 아래와 같이 @Configuration 어노테이션을 붙여주고 Docket 빈을 하나 생성하면 됩니다.
좀 더 상세한 설정을 하려면 공식사이트에서 확인가능합니다.
@Configuration
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
기존의 2.x 버전까지는 host<:port>/<context root>/swagger-ui.html 로 접속을 했었다면, v3부터는 host<:port>/<context root>/swagger-ui/ 또는 host<:port>/<context root>/swagger-ui/index.html 로 접속을 하면 됩니다.
[자료구조] AVL 트리 특징 및 로테이션 기준 (1) | 2020.11.29 |
---|---|
[AWS] ES와 연동된 키바나 에러 (Unable to find saved objects) (0) | 2020.11.28 |
[몽고DB] 기본 쉘 명령어 (0) | 2020.11.24 |
[몽고DB] MacOS에 몽고DB 최신버전(4.4.x) 설치하기 (0) | 2020.11.23 |
springboot 2.4 업그레이드 시 gradle 버전 오류 (0) | 2020.11.22 |