OpenApiProperties

OpenAPI(Swagger) 설정. API 문서 URL 관리.

클래스 정의

@ConfigurationProperties(prefix = "open-api")
@ConditionalOnProperty(
    name = [SPRINGDOC_ENABLED],
    havingValue = "true"
)
data class OpenApiProperties(
    val url: String
) : Serializable

필드

필드타입설명
urlStringOpenAPI 서버 URL

조건부 활성화

조건
springdoc.api-docs.enabledtrue

설정 예시

open-api:
  url: https://api.triple.guide

특징

  • @ConditionalOnProperty: springdoc 활성화 시에만 로드
  • Serializable: 직렬화 지원