728x90
Swagger란?
- REST API 를 설계, 빌드, 문서화 및 사용하는데 도움이 되는 OpenAPI 사양을 중심으로 구축된 오픈 소스 도구 세트
- 코드 몇 줄 추가를 통해 적용하기 쉬우며, 문서 화면에서 UI를 통해 바로 API 테스트가 가능한 장점
Swagger 사용 방법
- build.gradle 에 의존성 추가 : 2.9.2 버전
// build.gradle
dependencies {
compile('io.springfox:springfox-swagger2:2.9.2')
compile('io.springfox:springfox-swagger-ui:2.9.2')
}
Swagger Config 설정
package com.devtest.devtest.Config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
// config/SwaggerConfig.java
@Configuration
@EnableSwagger2
public class SwaggerConfig { // Swagger
private static final String API_NAME = "ToyProject API";
private static final String API_VERSION = "0.0.1";
private static final String API_DESCRIPTION = "ToyProject API 명세서";
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.devtest.devtest")) // Swagger를 적용할 클래스의 package명
.paths(PathSelectors.any()) // 해당 package 하위에 있는 모든 url에 적용
.build()
.apiInfo(apiInfo());
}
public ApiInfo apiInfo() { // API의 이름, 현재 버전, API에 대한 정보
return new ApiInfoBuilder()
.title("Swagger Test")
.description("SwaggerConfig")
.version("3.0")
.build();
}
}
Controller 빈 설정 및 명칭지정
http://localhost:8080/swagger-ui.html 으로 이동
API가 정상적으로 만들어지는것을 확인할수있다!
org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
다음과 같은 오류가 발생한다면 ?
다음 문구를 application properties에 추가한다.
spring.mvc.pathmatch.matching-strategy=ant_path_matcher728x90