Springdoc - use-fqn 설정으로 스웨거에서 Response 이름 충돌 문제 해결하기

스웨거 문서에서 Response 모델 이름이 충돌하여 발생하는 문제가 있을 수 있습니다.
Springdoc를 사용하여 간단하게 해결할 수 있습니다.

Springdoc는 스프링 부트 애플리케이션에서 OpenAPI 3.x 스펙을 지원하는 라이브러리입니다.
이를 사용하여 스웨거 문서를 생성하고 커스터마이징할 수 있습니다.
Springdoc를 사용하여 Response 이름 충돌 문제를 해결하는 방법에 대해 알아보겠습니다.

application.yml 설정하기: use-fqn 옵션을 true로 설정하여 Response 모델의 완전한 클래스 경로(Fully Qualified Name)를 사용하도록 설정합니다.
이를 통해 스웨거가 동일한 이름을 가진 모델을 구분할 수 있게 됩니다.

springdoc:
  use-fqn: true

위의 설정을 적용했을 때 Response 모델 이름이 충돌하지 않고 정확한 예시 값이 표시됩니다.

application.yml - springdoc 부분

springdoc:
  version: '1.6.13'
  api-docs:
    enabled: true
    path: /v3/api-docs
    groups:
      enabled: true
  swagger-ui:
    path: /swagger-ui.html
    tagsSorter: alpha
    use-root-path: true
    groups-order: desc
  cache:
    disabled: true
  use-fqn: true