Is `SpringDocSpecPropertiesConfiguration` supported?

[marceloverdijk]

While going through the github source code I noticed the SpringDocSpecPropertiesConfiguration and SpecPropertiesCustomizer which state:

Allows externalizing strings in generated openapi schema via properties that follow conventional naming similar or identical to openapi schema

To set value of a string in schema, define an application property that matches the target node with springdoc.spec-properties prefix.

Sample supported properties for api-info customization:

springdoc.spec-properties.info.title - to set title of api-info
springdoc.spec-properties.info.description - to set description of api-info
springdoc.spec-properties.info.version - to set version of api-info

This seemed quite useful as I'm doing that now in a custom OpenApiCustomizer.

However the springdocs docs say nothing about this in https://springdoc.org/#properties

I gave it a try but unfortunately it was not working...

Debugging a bit, the SpringDocSpecPropertiesConfiguration itself is created as uncondionalClass but it's beans are never created.

@Lazy(false)
@Configuration(proxyBeanMethods = false)
@ConditionalOnBean(SpringDocConfiguration.class)
@Conditional(SpecPropertiesCondition.class)
public class SpringDocSpecPropertiesConfiguration {

The SpecPropertiesCondition seems to return false...

	@Override
	public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
		final BindResult<SpringDocConfigProperties> result = Binder.get(context.getEnvironment())
				.bind(SPRINGDOC_PREFIX, SpringDocConfigProperties.class);
		if (result.isBound()) {
			SpringDocConfigProperties springDocConfigProperties = result.get();
			if (springDocConfigProperties.getOpenApi() != null)
				return true;
			Set<GroupConfig> groupConfigs = springDocConfigProperties.getGroupConfigs();
			return groupConfigs.stream().anyMatch(config -> config.getOpenApi() != null);
		}
		return false;
	}

The springDocConfigProperties.getOpenApi() is null...
and as I have no groups also the later statement will not match.

Is this supposed to work, and if so how?

[marceloverdijk]

Btw this (also undocumented) works...

springdoc.OpenApi.info.title=My API
springdoc.OpenApi.info.description=My Springdoc API
springdoc.OpenApi.info.version=1.0
springdoc.OpenApi.info.contact.name=Me
springdoc.OpenApi.info.contact.email=me@example.com
springdoc.OpenApi.info.contact.url=https://exmple.com

[marceloverdijk]

But trying to add extensions:

springdoc.OpenApi.info.extensions[x-logo].url=https://avatars.githubusercontent.com?s=300
springdoc.OpenApi.info.extensions[x-logo].altText=My API Logo

won't work. Or at least is not in the rendered openapi spec.

However while debugging, it is in the SpringDocConfigProperties

generated openapi spec (missing the x-logo extension):

{
  "openapi": "3.0.1",
  "info": {
    "title": "My API",
    "description": "My Springdoc API",
    "contact": {
      "name": "Me",
      "url": "https://example.com/",
      "email": "me@example.com"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "http://localhost:8080/",
      "description": "Generated server url".
    }
  ],
..

[bnasslahsen]

@marceloverdijk,

Yes it is supported.
See samples of extensions here:

springdoc-openapi/springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app213/HelloController.java

Lines 21 to 62 in ceb4a10

	@OpenAPIDefinition(
	info = @Info(
	extensions = { @Extension(
	name = "${api.extensions.name}",
	properties = {
	@ExtensionProperty(name = "type", value = "${api.extensions.properties.type}"),
	@ExtensionProperty(name = "connectionId", value = "${api.extensions.properties.connectionId}"),
	@ExtensionProperty(name = "httpMethod", value = "GET"),
	@ExtensionProperty(
	name = "uri",
	value = "${api.extensions.properties.uri}/testcontroller/getTest"),
	@ExtensionProperty(name = "passthroughBehavior", value = "${api.extensions.properties.passthroughBehavior}"),
	@ExtensionProperty(name = "connectionType", value = "${api.extensions.properties.connectionType}") }) },
	title = "${api.info.title}",
	version = "${api.info.version}",
	description = "${api.info.description}",
	termsOfService = "${api.info.termsOfService}"),
	servers = { @Server(description = "${api.server.description}", url = "${api.server.url}") })
	@Tag(name = "${api.tag.name}", description = "${api.tag.description}")
	@RestController
	@RequestMapping(value = "${api.base-request-mapping}/testcontroller", produces = MediaType.APPLICATION_JSON_VALUE)
	public class HelloController {
	@PostMapping(path = "/", produces = APPLICATION_JSON_VALUE, consumes = APPLICATION_JSON_VALUE)
	@Operation(
	summary = "Get Test",
	description = "Get Test",
	extensions = { @Extension(
	name = "${api.extensions.name}",
	properties = {
	@ExtensionProperty(name = "type", value = "${api.extensions.properties.type}"),
	@ExtensionProperty(name = "connectionId", value = "${api.extensions.properties.connectionId}"),
	@ExtensionProperty(name = "httpMethod", value = "GET"),
	@ExtensionProperty(
	name = "uri",
	value = "${api.extensions.properties.uri}/testcontroller/getTest"),
	@ExtensionProperty(name = "passthroughBehavior", value = "${api.extensions.properties.passthroughBehavior}"),
	@ExtensionProperty(name = "connectionType", value = "${api.extensions.properties.connectionType}") }) })
	public PersonDTO queryMyDto() {