Swagger를 사용해보았다.

Swagger는 프로젝트에서 지정한 URL을 위와 같이 html로 보여주는 API 자동화 프로젝트 이다.

간단한 CRUD 프로젝트를 진행하면서 Swagger를 사용하여

RESTful API 리스트 목록을 바로 편리하게 조회할 수 있었다.

---

spring boot : 최신 버전

Maven 기준 pom.xml 에 해당 dependency 추가

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

dependency를 추가하니 오류가 발생했는데,

spring boot 2.6버전 이후에 spring.mvc.pathmatch.matching-strategy 값이

ant_apth_matcher에서 path_pattern_parser로 변경되면서

몇몇 라이브러리(swagger포함)에 오류가 발생한다고 한다.

따라서 application.yml 에 아래 설정을 추가하면 오류가 발생 안한다.

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

 

그 다음, 프로젝트에 Swagger 설정 Bean을 등록한다.

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2);
    }
}

 

그리고 내 포트 8088 기준으로

http://localhost:8088/swagger-ui/index.html

URI로 이동해보면

Swagger가 만들어준 api 리스트를 볼 수 있다.