org.springdoc.core.customizers

Class SpecPropertiesCustomizer

java.lang.Object

org.springdoc.core.customizers.SpecPropertiesCustomizer

All Implemented Interfaces:

GlobalOpenApiCustomizer, OpenApiCustomiser

public class SpecPropertiesCustomizer
extends Object
implements GlobalOpenApiCustomizer

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
• springdoc.spec-properties.info.termsOfService - to set terms of service of api-info

Sample supported properties for components customization:

• springdoc.spec-properties.components.User.description - to set description of User model
• springdoc.spec-properties.components.User.properties.name.description - to set description of 'name' property
• springdoc.spec-properties.components.User.properties.name.example - to set example of 'name' property

Sample supported properties for paths/operationIds customization:

• springdoc.spec-properties.paths.{operationId}.description - to set description of {operationId}
• springdoc.spec-properties.paths.{operationId}.summary - to set summary of {operationId}

Support for groped openapi customization is similar to the above, but with a group name prefix. E.g.

• springdoc.spec-properties.{group-name}.info.title - to set title of api-info
• springdoc.spec-properties.{group-name}.components.User.description - to set description of User model
• springdoc.spec-properties.{group-name}.paths.{operationId}.description - to set description of {operationId}

Author:

Anton Tkachenko [email protected], bnasslahsen

Constructor Summary

Constructors

Constructor and Description
SpecPropertiesCustomizer(org.springframework.core.env.PropertyResolver resolverUtils) Instantiates a new Spec properties customizer.
SpecPropertiesCustomizer(org.springframework.core.env.PropertyResolver propertyResolver, String groupName) Instantiates a new Spec properties customizer.

Method Summary

Modifier and Type	Method and Description
void	customise(io.swagger.v3.oas.models.OpenAPI openApi) Customise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpecPropertiesCustomizer

public SpecPropertiesCustomizer(org.springframework.core.env.PropertyResolver resolverUtils)

Instantiates a new Spec properties customizer.

Parameters:

resolverUtils - the resolver utils

SpecPropertiesCustomizer

public SpecPropertiesCustomizer(org.springframework.core.env.PropertyResolver propertyResolver,
                                String groupName)

Instantiates a new Spec properties customizer.

Parameters:

propertyResolver - the property resolver

groupName - the group name

Method Detail

customise

public void customise(io.swagger.v3.oas.models.OpenAPI openApi)

Description copied from interface: OpenApiCustomiser

Customise.

Specified by:

customise in interface OpenApiCustomiser

Parameters:

openApi - the open api