Package org.springdoc.webmvc.api

Class OpenApiResource

java.lang.Object

io.swagger.v3.core.filter.SpecFilter

org.springdoc.api.AbstractOpenApiResource

org.springdoc.webmvc.api.OpenApiResource

Direct Known Subclasses:

OpenApiActuatorResource, OpenApiWebMvcResource

public abstract class OpenApiResource
extends AbstractOpenApiResource

The type Web mvc open api resource.

Author:

bnasslahsen, Azige

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping	requestMappingHandlerMapping	The Request mapping handler mapping.

Fields inherited from class org.springdoc.api.AbstractOpenApiResource

groupName, openAPIService, optionalActuatorProvider, springDocConfigProperties

Constructor Summary

Constructors

Constructor	Description
OpenApiResource(String groupName, org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping, Optional<ActuatorProvider> actuatorProvider, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomiser>> openApiCustomisers, SpringDocConfigProperties springDocConfigProperties, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider, Optional<RouterFunctionProvider> routerFunctionProvider, Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider)	Instantiates a new Open api resource.
OpenApiResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping, Optional<ActuatorProvider> actuatorProvider, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomiser>> openApiCustomisers, SpringDocConfigProperties springDocConfigProperties, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider, Optional<RouterFunctionProvider> routerFunctionProvider, Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider)	Instantiates a new Open api resource.

Method Summary

Modifier and Type	Method	Description
protected void	calculatePath(Map<String,Object> restControllers, Map<org.springframework.web.servlet.mvc.method.RequestMappingInfo,org.springframework.web.method.HandlerMethod> map, Locale locale)	Calculate path.
protected void	calculateServerUrl(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)	Calculate server url.
static Set<String>	getActivePatterns(org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMappingInfo)	Gets active patterns.
protected void	getPaths(Map<String,Object> restControllers, Locale locale)
protected abstract String	getServerUrl(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)	Gets server url.
String	openapiJson(javax.servlet.http.HttpServletRequest request, String apiDocsUrl, Locale locale)	Openapi json string.
String	openapiYaml(javax.servlet.http.HttpServletRequest request, String apiDocsUrl, Locale locale)	Openapi yaml string.

Methods inherited from class org.springdoc.api.AbstractOpenApiResource

addHiddenRestControllers, addHiddenRestControllers, addRestControllers, calculatePath, calculatePath, calculatePath, calculatePath, containsResponseBody, customiseOperation, decode, getActuatorURI, getDefaultAllowedHttpMethods, getOpenApi, getRouterFunctionPaths, initOpenAPIBuilder, isActuatorRestController, isAdditionalRestController, isConditionToMatch, isFilterCondition, isHiddenRestControllers, isPackageToScan, isPathToMatch, isRestController, isShowActuator, mergeRouters, writeJsonValue, writeYamlValue

Methods inherited from class io.swagger.v3.core.filter.SpecFilter

filter, filterComponentsSchema, filterOpenAPI, filterOperation, filterParameter, filterPathItem, filterRequestBody, filterResponse, locateReferencedDefinitions, removeBrokenReferenceDefinitions, resolveAllNestedRefs

Methods inherited from class java.lang.Object

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

Field Detail

requestMappingHandlerMapping

protected final org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping

The Request mapping handler mapping.

Constructor Detail

OpenApiResource

public OpenApiResource(String groupName,
                       org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
                       AbstractRequestService requestBuilder,
                       GenericResponseService responseBuilder,
                       OperationService operationParser,
                       org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
                       Optional<ActuatorProvider> actuatorProvider,
                       Optional<List<OperationCustomizer>> operationCustomizers,
                       Optional<List<OpenApiCustomiser>> openApiCustomisers,
                       SpringDocConfigProperties springDocConfigProperties,
                       Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,
                       Optional<RouterFunctionProvider> routerFunctionProvider,
                       Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider)

Instantiates a new Open api resource.

Parameters:

groupName - the group name

openAPIBuilderObjectFactory - the open api builder object factory

requestBuilder - the request builder

responseBuilder - the response builder

operationParser - the operation parser

requestMappingHandlerMapping - the request mapping handler mapping

actuatorProvider - the actuator provider

operationCustomizers - the operation customizers

openApiCustomisers - the open api customisers

springDocConfigProperties - the spring doc config properties

springSecurityOAuth2Provider - the spring security o auth 2 provider

routerFunctionProvider - the router function provider

repositoryRestResourceProvider - the repository rest resource provider

OpenApiResource

public OpenApiResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
                       AbstractRequestService requestBuilder,
                       GenericResponseService responseBuilder,
                       OperationService operationParser,
                       org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
                       Optional<ActuatorProvider> actuatorProvider,
                       Optional<List<OperationCustomizer>> operationCustomizers,
                       Optional<List<OpenApiCustomiser>> openApiCustomisers,
                       SpringDocConfigProperties springDocConfigProperties,
                       Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,
                       Optional<RouterFunctionProvider> routerFunctionProvider,
                       Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider)

Instantiates a new Open api resource.

Parameters:

openAPIBuilderObjectFactory - the open api builder object factory

requestBuilder - the request builder

responseBuilder - the response builder

operationParser - the operation parser

requestMappingHandlerMapping - the request mapping handler mapping

actuatorProvider - the actuator provider

operationCustomizers - the operation customizers

openApiCustomisers - the open api customisers

springDocConfigProperties - the spring doc config properties

springSecurityOAuth2Provider - the spring security o auth 2 provider

routerFunctionProvider - the router function provider

repositoryRestResourceProvider - the repository rest resource provider

Method Detail

openapiJson

public String openapiJson(javax.servlet.http.HttpServletRequest request,
                          String apiDocsUrl,
                          Locale locale)
                   throws com.fasterxml.jackson.core.JsonProcessingException

Openapi json string.

Parameters:

request - the request

apiDocsUrl - the api docs url

locale - the locale

Returns:

the string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

openapiYaml

public String openapiYaml(javax.servlet.http.HttpServletRequest request,
                          String apiDocsUrl,
                          Locale locale)
                   throws com.fasterxml.jackson.core.JsonProcessingException

Openapi yaml string.

Parameters:

request - the request

apiDocsUrl - the api docs url

locale - the locale

Returns:

the string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

getPaths

protected void getPaths(Map<String,Object> restControllers,
                        Locale locale)

Specified by:

getPaths in class AbstractOpenApiResource

calculatePath

protected void calculatePath(Map<String,Object> restControllers,
                             Map<org.springframework.web.servlet.mvc.method.RequestMappingInfo,org.springframework.web.method.HandlerMethod> map,
                             Locale locale)

Calculate path.

Parameters:

restControllers - the rest controllers

map - the map

locale - the locale

getActivePatterns

public static Set<String> getActivePatterns(org.springframework.web.servlet.mvc.method.RequestMappingInfo requestMappingInfo)

Gets active patterns.

Parameters:

requestMappingInfo - the request mapping info

Returns:

the active patterns

calculateServerUrl

protected void calculateServerUrl(javax.servlet.http.HttpServletRequest request,
                                  String apiDocsUrl)

Calculate server url.

Parameters:

request - the request

apiDocsUrl - the api docs url

getServerUrl

protected abstract String getServerUrl(javax.servlet.http.HttpServletRequest request,
                                       String apiDocsUrl)

Gets server url.

Parameters:

request - the request

apiDocsUrl - the api docs url

Returns:

the server url