SpringDoc OpenAPI

Spring Boot가 버전업되면서 Swagger를 dependency로 사용하는 것 대신 SpringDoc을 dependency로 추가해야 합니다.

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

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

application.properties 에 다음의 파라미터를 변경할 수 있습니다.

# Swagger UI
# http://serverName:applicationPort/swagger-ui.html로 접근 가능
springdoc.swagger-ui.path=/swagger-ui.html

# WebMVC API를 위한 API Doc의 Endpoint
springdoc.api-docs.path=/api-docs

# Controller 필터링 (필요시 적용)
springdoc.packagesToScan=com.package1, com.package2
springdoc.pathsToMatch=/v1, /api/balance/**

# Spring Boot Acturator에 표시를 위한 설정
# spring-boot-actuator를 추가해야 함
# http://serverName:managementPort/actuator/swagger-ui 으로 접근 가능
springdoc.show-actuator=true

# 관리 포트로 Swagger UI를 노출
springdoc.use-management-port=true

# OpenAPI 및 Swagger UI를 Actuator쪽에 노출
# http://serverName:managementPort/actuator/openapi
# http://serverName:managementPort/actuator/swagger-ui
management.endpoints.web.exposure.include=openapi, swagger-ui

SpringDoc에 대한 상세한 정보는 OpenAPI 3 Library for spring-boot (springdoc.org) 을 참고하십시오.

Page tree

SpringDoc OpenAPI