org.springdoc.core.customizers

Class SpecificationStringPropertiesCustomizer

java.lang.Object

org.springdoc.core.customizers.SpecificationStringPropertiesCustomizer

All Implemented Interfaces:

GlobalOpenApiCustomizer, OpenApiCustomiser

public class SpecificationStringPropertiesCustomizer
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.specification-strings prefix.

Sample supported properties for api-info customization:

• springdoc.specification-strings.info.title - to set title of api-info
• springdoc.specification-strings.info.description - to set description of api-info
• springdoc.specification-strings.info.version - to set version of api-info
• springdoc.specification-strings.info.termsOfService - to set terms of service of api-info

Sample supported properties for components customization:

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

Sample supported properties for paths/operationIds customization:

• springdoc.specification-strings.paths.{operationId}.description - to set description of {operationId}
• springdoc.specification-strings.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.specification-strings.{group-name}.info.title - to set title of api-info
• springdoc.specification-strings.{group-name}.components.User.description - to set description of User model
• springdoc.specification-strings.{group-name}.paths.{operationId}.description - to set description of {operationId}

Author:

Anton Tkachenko [email protected]

Constructor Summary

Constructors

Constructor and Description
SpecificationStringPropertiesCustomizer(org.springframework.core.env.PropertyResolver resolverUtils)
SpecificationStringPropertiesCustomizer(org.springframework.core.env.PropertyResolver propertyResolver, String groupName)

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

SpecificationStringPropertiesCustomizer

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

SpecificationStringPropertiesCustomizer

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

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