Invalid server url when springdoc.api-docs.path defined

[tuomari]

When springdoc.api-docs.path is defined to for example /documents/v3/api-docs server url becomes invalid:

"servers": [
        {
            "url": "http://loca",
            "description": "Generated server url"
        }
    ],

the url should be http://localhost:8080

The culprit seems to be this snippet of code, where prefix becomes /documents, but apiDocsUrl already contains the prefix: /documents/v3/api-docs, so the prefix length gets subtracted twice.

springdoc-openapi/springdoc-openapi-starter-webmvc-api/src/main/java/org/springdoc/webmvc/api/OpenApiWebMvcResource.java

Lines 145 to 152 in 31ba90b

	protected String getServerUrl(HttpServletRequest request, String apiDocsUrl) {
	String requestUrl = decode(request.getRequestURL().toString());
	Optional<SpringWebProvider> springWebProviderOptional = springDocProviders.getSpringWebProvider();
	String prefix = StringUtils.EMPTY;
	if (springWebProviderOptional.isPresent())
	prefix = springWebProviderOptional.get().findPathPrefix(springDocConfigProperties);
	return requestUrl.substring(0, requestUrl.length() - apiDocsUrl.length() - prefix.length());
	}

Version info

Spring boot version 3.5.5
springdoc-openapi-starter-webmvc-ui : 2.8.12

[bnasslahsen]

@tuomari,

Not reproducible.
Feel free to provide a Minimal, Reproducible Example - with HelloController that reproduces the problem.

This ticket will be closed, but can be reopened if your provide the reproducible sample.

[mariusschwan]

We just ran into the same issue.
The problem persists: getServerUrl() occasionally returns an incorrect URL, which leads to a StringIndexOutOfBoundsException.
This also causes the "Servers" dropdown in Swagger UI to show invalid or incomplete entries, as already mentioned above.

It is not instantly reproducible. Sometimes we need about 15 restarts of our applications to get the error.

Used versions:
Spring Boot 3.5.3
springdoc-openapi-starter-webmvc-ui 2.8.3