[REST API] Swagger로 API 문서 자동화

API 서버가 어떤 스펙을 가지고 있는지 문서화는 꼭 필요한 작업인데, Swagger는 간단한 설정으로 프로젝트에서 지정한 URL들을 HTML 화면으로 확인할 수 있게 해주는 프로젝트다.

과정

1) 의존성 추가
2) Swagger Config 클래스 작성 및 Bean 으로 등록
3) Swagger ui 확인

1) 의존성 추가

build.gradle 파일에 다음과 같이 의존성 추가

    implementation 'io.springfox:springfox-swagger2:2.6.1'
    implementation 'io.springfox:springfox-swagger-ui:2.6.1'

2) Swagger Config 클래스 작성 및 Bean 으로 등록

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

3) Swagger ui 확인

인테리J나 이클립스에서 서비스를 실행한 후 브라우저에서 다음 URL로 확인 가능

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

참고자료
swagger 사이트
springboot2로 Rest api 만들기(4) Swagger API 문서 자동화
spring boot REST API Web 프로로젝트(3) - API 관리를 위한 Swagger 적용
Swagger로 API 문서 자동화하기