Servers from cached OpenAPI are overwritten when reusing existing server instances in openApiCustomisers

[edudar]

I have an OpenAPI customizer that appends a special path suffix to server URLs. It works fine and shows proper values in UI in "Servers" dropdown. Upon page refresh, dropdown values reset to un-customized ones.

Spring Boot 2.5.7
SpringDoc 1.5.12

The problem is in AbstractOpenApiResource.getOpenApi() function. When it loads for the first time, there's no cached OpenAPI instance so full initialization goes through and runs

openApiCustomisers.ifPresent(apiCustomisers -> 
  apiCustomisers.forEach(openApiCustomiser -> 
    openApiCustomiser.customise(openApi)));

On a subsequent reload however, there's a cached version and the code goes straight into

openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI());

that overrides correct, customized servers with a new "generated" version and does not run any customization.

I don't know why would it be needed to overwrite servers in cached OpenAPI but if that's indeed required, I'd expect customization to be applied again. Otherwise /api-docs returns different responses on the first vs further calls.

Workaround: disable cache but load times increase depending on the complexity of your project.

[bnasslahsen]

@edudar,

Even the cache is enabled, the expected behavior is that the servers.url property generated in openapi spec, for each incoming request will be based on request's x-forwarded-* headers and not only the first load.

For overriding the servers using openApiCustomiser, this is a duplicate of #1188 and #1260.
There was regression since v1.5.7 and fixed with v1.5.11

Overriding servers using openApiCustomiser, it should be now possible: And this is a sample test that shows you how to implement it.

springdoc-openapi/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app162/OpenApiConfig.java

Lines 11 to 24 in d8fbf32

	@Configuration
	public class OpenApiConfig {
	@Bean
	OpenApiCustomiser openApiCustomiser() {
	return openApi -> {
	openApi.getInfo().version("v1");
	Server server = new Server().url("");
	List<Server> servers=new ArrayList<>();
	servers.add(server);
	openApi.servers(servers);
	};
	}
	}

Make sure when you log issue to provide a Minimal, Reproducible Example - with HelloController that reproduces the problem
Note: For next time, make sure you log issues after testing with the last stable release (for example today: v1.5.13)

All these steps are mentioned in the contribution guidelines.

This ticket will be closed and can be reopened if you update it with any relevant information as described in the contribution guidelines.

[edudar]

@bnasslahsen I specified that I'm using springdoc 1.5.12 which was the latest when I was doing testing. 1.5.13 was released an hour before I filed this ticket and it was not propagated everywhere.

Here's a minimal example: https://github.com/edudar/springdoc-1353

[bnasslahsen]

@edudar,

I see the cause of your error, related to the fact that you are modifying the existing Server instances.
The workaround, until the next release without disabling the cache, is you create a new server instance, as shown in the sample test.