Package org.springdoc.core.service

Class OpenAPIService

java.lang.Object

org.springdoc.core.service.OpenAPIService

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class OpenAPIService
extends Object
implements org.springframework.context.ApplicationContextAware

The type Open api builder.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor	Description
OpenAPIService(Optional<io.swagger.v3.oas.models.OpenAPI> openAPI, SecurityService securityParser, SpringDocConfigProperties springDocConfigProperties, PropertyResolverUtils propertyResolverUtils, Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomizers, Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomizers, Optional<JavadocProvider> javadocProvider)	Instantiates a new Open api builder.

Method Summary

Modifier and Type	Method	Description
void	addMappings(Map<String,Object> mappings)	Add mappings.
void	addTag(Set<org.springframework.web.method.HandlerMethod> handlerMethods, io.swagger.v3.oas.models.tags.Tag tag)	Add tag.
io.swagger.v3.oas.models.OpenAPI	build(Locale locale)	Build.
io.swagger.v3.oas.models.Operation	buildTags(org.springframework.web.method.HandlerMethod handlerMethod, io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.OpenAPI openAPI, Locale locale)	Build tags operation.
void	buildTagsFromClass(Class<?> beanType, Set<io.swagger.v3.oas.models.tags.Tag> tags, Set<String> tagsStr, Locale locale)	Build tags from class.
io.swagger.v3.oas.models.OpenAPI	getCachedOpenAPI(Locale locale)	Gets cached open api.
org.springframework.context.ApplicationContext	getContext()	Gets context.
Map<String,Object>	getControllerAdviceMap()	Gets controller advice map.
Map<String,Object>	getMappingsMap()	Gets mappings map.
SecurityService	getSecurityParser()	Gets security parser.
boolean	isAutoTagClasses(io.swagger.v3.oas.models.Operation operation)	Is auto tag classes boolean.
io.swagger.v3.oas.models.media.Schema	resolveProperties(io.swagger.v3.oas.models.media.Schema schema, Locale locale)	Resolve properties schema.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCachedOpenAPI(io.swagger.v3.oas.models.OpenAPI cachedOpenAPI, Locale locale)	Sets cached open api.
void	setServerBaseUrl(String serverBaseUrl)	Sets server base url.
void	setServersPresent(boolean serversPresent)	Sets servers present.
static String	splitCamelCase(String str)	Split camel case string.
void	updateServers(io.swagger.v3.oas.models.OpenAPI openAPI)	Update servers open api.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenAPIService

public OpenAPIService(Optional<io.swagger.v3.oas.models.OpenAPI> openAPI,
 SecurityService securityParser,
 SpringDocConfigProperties springDocConfigProperties,
 PropertyResolverUtils propertyResolverUtils,
 Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomizers,
 Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomizers,
 Optional<JavadocProvider> javadocProvider)

Instantiates a new Open api builder.

Parameters:

openAPI - the open api

securityParser - the security parser

springDocConfigProperties - the spring doc config properties

propertyResolverUtils - the property resolver utils

openApiBuilderCustomizers - the open api builder customisers

serverBaseUrlCustomizers - the server base url customizers

javadocProvider - the javadoc provider

Method Details

splitCamelCase

public static String splitCamelCase(String str)

Split camel case string.

Parameters:

str - the str

Returns:

the string

build

public io.swagger.v3.oas.models.OpenAPI build(Locale locale)

Build.

Parameters:

locale - the locale

Returns:

the open api

updateServers

public void updateServers(io.swagger.v3.oas.models.OpenAPI openAPI)

Update servers open api.

Parameters:

openAPI - the open api

setServersPresent

public void setServersPresent(boolean serversPresent)

Sets servers present.

Parameters:

serversPresent - the servers present

buildTags

public io.swagger.v3.oas.models.Operation buildTags(org.springframework.web.method.HandlerMethod handlerMethod,
 io.swagger.v3.oas.models.Operation operation,
 io.swagger.v3.oas.models.OpenAPI openAPI,
 Locale locale)

Build tags operation.

Parameters:

handlerMethod - the handler method

operation - the operation

openAPI - the open api

locale - the locale

Returns:

the operation

buildTagsFromClass

public void buildTagsFromClass(Class<?> beanType,
 Set<io.swagger.v3.oas.models.tags.Tag> tags,
 Set<String> tagsStr,
 Locale locale)

Build tags from class.

Parameters:

beanType - the bean type

tags - the tags

tagsStr - the tags str

locale - the locale

resolveProperties

public io.swagger.v3.oas.models.media.Schema resolveProperties(io.swagger.v3.oas.models.media.Schema schema,
 Locale locale)

Resolve properties schema.

Parameters:

schema - the schema

locale - the locale

Returns:

the schema

setServerBaseUrl

public void setServerBaseUrl(String serverBaseUrl)

Sets server base url.

Parameters:

serverBaseUrl - the server base url

isAutoTagClasses

public boolean isAutoTagClasses(io.swagger.v3.oas.models.Operation operation)

Is auto tag classes boolean.

Parameters:

operation - the operation

Returns:

the boolean

addTag

public void addTag(Set<org.springframework.web.method.HandlerMethod> handlerMethods,
 io.swagger.v3.oas.models.tags.Tag tag)

Add tag.

Parameters:

handlerMethods - the handler methods

tag - the tag

getMappingsMap

public Map<String,Object> getMappingsMap()

Gets mappings map.

Returns:

the mappings map

addMappings

public void addMappings(Map<String,Object> mappings)

Add mappings.

Parameters:

mappings - the mappings

getControllerAdviceMap

public Map<String,Object> getControllerAdviceMap()

Gets controller advice map.

Returns:

the controller advice map

getCachedOpenAPI

public io.swagger.v3.oas.models.OpenAPI getCachedOpenAPI(Locale locale)

Gets cached open api.

Parameters:

locale - associated the cache entry

Returns:

the cached open api

setCachedOpenAPI

public void setCachedOpenAPI(io.swagger.v3.oas.models.OpenAPI cachedOpenAPI,
 Locale locale)

Sets cached open api.

Parameters:

cachedOpenAPI - the cached open api

locale - associated the cache entry

getContext

public org.springframework.context.ApplicationContext getContext()

Gets context.

Returns:

the context

getSecurityParser

public SecurityService getSecurityParser()

Gets security parser.

Returns:

the security parser

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException