[Spring boot3] SpringDoc - OpenAPI Servers url 수정

OpenApi

이슈

Swagger... 아니 SpringDoc OpenApi 에서 Servers Url이 http://{dockerAlias} 로 나오는 현상이 발생했다.

외부에서 테스트할때 당연히 될 리가 없다.

예를 들어 docker-compose 서비스명이 back이라고 지정했다 치면 

http://back:8080 으로 돼버린다. 이게 로드되는 동안 리소스는 이상 없이 될지 몰라도, 실제 try it 하는 순간 먹통이 된다.

Servers Url 을 바꾸기 위해 다양한 방법을 찾아봤지만, 결국 아래 방법으로 해결하여 이를 공유한다.

 

해결 방안

@OpenAPIDefinition(
        servers = {
                @Server(url = "http://dev-api.test.kr", description = "Dev-Server"),
                @Server(url = "http://127.0.0.1:8080", description = "Local-Server")
        }
)
public class OpenApiConfig {}

 

결론은, 어노테이션 처리로 해결했다.

다른 빈 등록을 통한 다양한 방법들도 있었지만, 이 방법이 가장 직관적이고 깔끔해 보여 이를 사용하여 처리했다.