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 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, 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, 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
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 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, Locale locale)
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
-
-
-
-
Constructor Detail
-
OpenApiResource
public OpenApiResource(String groupName, org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, 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 nameopenAPIBuilderObjectFactory
- the open api builder object factoryrequestBuilder
- the request builderresponseBuilder
- the response builderoperationParser
- the operation parseractuatorProvider
- the actuator provideroperationCustomizers
- the operation customizersopenApiCustomisers
- the open api customisersspringDocConfigProperties
- the spring doc config propertiesspringSecurityOAuth2Provider
- the spring security o auth 2 providerrouterFunctionProvider
- the router function providerrepositoryRestResourceProvider
- the repository rest resource provider
-
OpenApiResource
public OpenApiResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, 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 factoryrequestBuilder
- the request builderresponseBuilder
- the response builderoperationParser
- the operation parseractuatorProvider
- the actuator provideroperationCustomizers
- the operation customizersopenApiCustomisers
- the open api customisersspringDocConfigProperties
- the spring doc config propertiesspringSecurityOAuth2Provider
- the spring security o auth 2 providerrouterFunctionProvider
- the router function providerrepositoryRestResourceProvider
- 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 requestapiDocsUrl
- the api docs urllocale
- 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 requestapiDocsUrl
- the api docs urllocale
- 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 classAbstractOpenApiResource
-
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 controllersmap
- the maplocale
- 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, Locale locale)
Calculate server url.- Parameters:
request
- the requestapiDocsUrl
- the api docs url
-
-