SwaggerUI

SpringMVC 프로젝트에 간단하게
Swagger UI설정 및 사용하기
https://cofived.tistory.com/27

 

pom.xml 파일에 라이브러리 추가

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>

 

IntelliJ 사용한다면

file > project struncture > Project Settings > Artifact에서

배포용 war선택하고, 우측에 있는 Available Element에서 추가된 라이브러리를 모두 더블클릭

 

servlet-context.xml파일에 아래 내용 추가

<beans:bean id="swagger2Config" class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration">
</beans:bean>

<default-servlet-handler />
<resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"></resources>
<resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"></resources>

 

톰캣기동후 아래와 같이 접속

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

 

 

Spring Boot 에서는

src/main/resource 밑에 config 패치지 만들고 SwaggerConfig.java 파일 생성하면됨

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any()) // 현재 RequestMapping으로 할당된 모든 URL 리스트를 추출
                .paths(PathSelectors.ant("/api/**")) // 그중 /api/** 인 URL들만 필터링
                .build();
    }
}