Swagger 라이브러리 사용하기(API 명세서 자동화)

Swagger 란?

 

프로젝트 내의 API 명세서를 자동으로 만들어 HTML 화면으로 보여주는 라이브러리이다.

 

 

설정방법

 

1. pom.xml 또는 build.gradle 에 라이브러리 추가

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

// https://mvnrepository.com/artifact/io.springfox/springfox-swagger2
implementation group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'

// https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui
implementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'

 

 

2. SwaggerConfiguration 클래스 생성

package com.example.demo.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;

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
	
	@Bean
	public Docket api() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.example.demo"))		//swagger가 rest api 스캔 시 어디서 부터 스캔할지 기준(root 패키지)
				.paths(PathSelectors.any())
				.build();			
	}
	
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("Around Hub Open API Test with Swagger")
				.description("설명 부분")
				.version("1.0.0")
				.build();
	}
}

 

 

3. application.properties 에 아래 내용 추가

spring.mvc.pathmatch.matching-strategy = ant_path_matcher