Package org.springdoc.webmvc.api
Class OpenApiActuatorResource
- java.lang.Object
-
- io.swagger.v3.core.filter.SpecFilter
-
- org.springdoc.api.AbstractOpenApiResource
-
- org.springdoc.webmvc.api.OpenApiResource
-
- org.springdoc.webmvc.api.OpenApiActuatorResource
-
@RestControllerEndpoint(id="openapi") public class OpenApiActuatorResource extends OpenApiResource
The type Open api actuator resource.- Author:
- bnasslashen
-
-
Field Summary
-
Fields inherited from class org.springdoc.api.AbstractOpenApiResource
groupName, openAPIService, springDocConfigProperties, springDocProviders
-
-
Constructor Summary
Constructors Constructor Description OpenApiActuatorResource(String groupName, org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomiser>> openApiCustomisers, Optional<List<RouterOperationCustomizer>> routerOperationCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders)
Instantiates a new Open api actuator resource.OpenApiActuatorResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomiser>> openApiCustomisers, Optional<List<RouterOperationCustomizer>> routerOperationCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders)
Instantiates a new Open api actuator resource.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
getServerUrl(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)
Gets server url.String
openapiJson(javax.servlet.http.HttpServletRequest request, Locale locale)
Openapi json string.String
openapiYaml(javax.servlet.http.HttpServletRequest request, Locale locale)
Openapi yaml string.-
Methods inherited from class org.springdoc.webmvc.api.OpenApiResource
calculatePath, calculateServerUrl, getPaths, openapiJson, openapiYaml
-
Methods inherited from class org.springdoc.api.AbstractOpenApiResource
addHiddenRestControllers, addHiddenRestControllers, addRestControllers, calculatePath, calculatePath, calculatePath, calculatePath, containsResponseBody, customizeOperation, customizeRouterOperation, decode, getActuatorURI, getDefaultAllowedHttpMethods, getOpenApi, getRouterFunctionPaths, initOpenAPIBuilder, isActuatorRestController, isAdditionalRestController, isConditionToMatch, isFilterCondition, isHiddenRestControllers, isMethodToFilter, isPackageToScan, isPathToMatch, isRestController, mergeRouters, setModelAndViewClass, writeJsonValue, writeYamlValue
-
-
-
-
Constructor Detail
-
OpenApiActuatorResource
public OpenApiActuatorResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomiser>> openApiCustomisers, Optional<List<RouterOperationCustomizer>> routerOperationCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders)
Instantiates a new Open api actuator resource.- Parameters:
openAPIBuilderObjectFactory
- the open api builder object factoryrequestBuilder
- the request builderresponseBuilder
- the response builderoperationParser
- the operation parseroperationCustomizers
- the operation customizersopenApiCustomisers
- the open api customisersrouterOperationCustomizers
- the router operation customizersmethodFilters
- the method filtersspringDocConfigProperties
- the spring doc config propertiesspringDocProviders
- the spring doc providers
-
OpenApiActuatorResource
public OpenApiActuatorResource(String groupName, org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<OpenApiCustomiser>> openApiCustomisers, Optional<List<RouterOperationCustomizer>> routerOperationCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders)
Instantiates a new Open api actuator resource.- Parameters:
groupName
- the group nameopenAPIBuilderObjectFactory
- the open api builder object factoryrequestBuilder
- the request builderresponseBuilder
- the response builderoperationParser
- the operation parseroperationCustomizers
- the operation customizersopenApiCustomisers
- the open api customisersrouterOperationCustomizers
- the router operation customizersmethodFilters
- the method filtersspringDocConfigProperties
- the spring doc config propertiesspringDocProviders
- the spring doc providers
-
-
Method Detail
-
openapiJson
@GetMapping(value="/", produces="application/json") public String openapiJson(javax.servlet.http.HttpServletRequest request, Locale locale) throws com.fasterxml.jackson.core.JsonProcessingException
Openapi json string.- Parameters:
request
- the requestlocale
- the locale- Returns:
- the string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
- the json processing exception
-
openapiYaml
@GetMapping(value="/yaml", produces="application/vnd.oai.openapi") public String openapiYaml(javax.servlet.http.HttpServletRequest request, Locale locale) throws com.fasterxml.jackson.core.JsonProcessingException
Openapi yaml string.- Parameters:
request
- the requestlocale
- the locale- Returns:
- the string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
- the json processing exception
-
getServerUrl
protected String getServerUrl(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)
Description copied from class:OpenApiResource
Gets server url.- Specified by:
getServerUrl
in classOpenApiResource
- Parameters:
request
- the requestapiDocsUrl
- the api docs url- Returns:
- the server url
-
-