본문 바로가기
개발/SpringBoot

springdoc swagger ui disable Petstore(swagger-ui enabled false not working)

by 궁즉변 변즉통 통즉구 2023. 6. 19.
반응형

Springdoc SwaggerUI를 사용하면서 한가지 이상점을 발견했다. SwaggerUI 설정을 QA, PRD 환경 등에서 disalbe 처리를 하기 위해서 아래와 같이 application.yml파일에 간단히 disable 설정을하고 테스트를 해봤다.

springdoc:
  swagger-ui:
    enabled: false

 

Application의 API는 diable처리가 됐는데 Swagger의 기본 샘플인 Petstore API가 나타나기 시작한것이다. 사실 Application의 API Doc을 제한하겠다는 목적은 달성했다하지만 그렇다고 기본 샘플이 뜨는것은 이해가 안되는 상황이고 찜찜하다.

yml 설정에서 'disable-swagger-default-url: true' 등 기타 다른 설정들을 모두 해봤지만 소용이 없었다. swagger 라이브러리의 webjar에 포함된 기본 샘플인데 yml설정의 springdoc.swagger-ui.enabled 설정과 통합이 안되어있는 거 같다. 

 

그리고 springdoc 버전을 확인해봤다. 현재 적용되어 있는 버전은 2.0.2버전이 적용되어 있었고, 이를 2.1.2로 버전을 올려서 실행했다.

implementation 'org.springdoc:springdoc-openapi-starter-common:2.1.2'
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.2'

그리고 application.yml 설정은 처음 설정으로 돌려놨다.

springdoc:
  swagger-ui:
    enabled: false

 

어제 더이상 Petstore가 실행되지 않고, 404가 응답된다. springdoc 버전을 올리면서 설정에 대한 패치가 된 것 같다.

 

반응형

댓글