[SpringBoot] 스프링부트 스웨거(Swagger) 사용법 및 테스트

1. 스웨거(Swagger)

---

[ Swagger ]

스웨거는 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다. - 위키

내가 만든 rest api들의 매핑주소를(URL) 입력하여 테스트 할 수 있는 아주 유용한 아이! 

 

2. 사용방법

(1) 스웨거 의존성 추가 (메이븐)

		<dependency>  //버전 확인하기
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>

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

 

(2) 스웨거 기능 추가 

 (1) SwaggerConfig 클래스 생성

 (2) 어노테이션 추가 및 기능 활성화

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo())
                .enable(true);
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API 타이틀")
                .description("API 상세소개 및 사용법")
                .version("1.0")
                .build();
    }

}

 

 

3. 스웨거 테스트 및 주소

---

Swgger URL: http://<ip>:<port>/<base>/swagger-ui.html
ex) http://localhost:8080/swagger-ui.html 

컨트롤러에 등록된 api들이 나옴을 알 수 있다 ㅎㅎ! 

 

아래 의 id를 인자로 받는 get메소드는 아래 두 번째 사진처럼 등록된다.

우측 상단 try it out을 누르고 id값을 받아서 excute를 누르면 컨트롤러가 실행되고 결과는 좌측 하단 code 밑에 숫자로 나온다.

ex 200 : 정상 실행

리턴 값은 Description 칸에 나온다.