SpringBoot 3.* Swagger 적용 방법

SpringBoot 프로젝트

SpringBoot 프로젝트에서 swagger-ui를 적용하려면 build.gradle에 아래의 의존성을 추가하면 됩니다.

의존성 추가

 <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.4.0</version>
   </dependency>

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.4.0'

다른 설정이 없다면 아래의 경로로 API DOCS에 접근할 수 있습니다.

• http://127.0.0.1:8080/swagger-ui/index.html

API DOCS URL 수정

만약 진입 경로를 수정하고 싶으면 application.properties

# swagger-ui custom path
springdoc.swagger-ui.path=/swagger-ui.html

Spring MVC

springboot가 아닌, spring web mvc를 사용하는 경우 아래의 의존성을 추가하면 됩니다.

 <dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
    <version>2.4.0</version>
 </dependency>

Spring WebFlux

springboot가 아닌, spring web mvc를 사용하는 경우 아래의 의존성을 추가하면 됩니다.

 <dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-api</artifactId>
    <version>2.4.0</version>
 </dependency>

참고

• https://springdoc.org/