@RestController
@ConditionalOnProperty(name="springdoc.enable-default-api-docs",
havingValue="true",
matchIfMissing=true)
public class OpenApiWebMvcResource
extends OpenApiResource
groupName, openAPIService, springDocConfigProperties, springDocCustomizers, springDocProviders| Constructor and Description |
|---|
OpenApiWebMvcResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
AbstractRequestService requestBuilder,
GenericResponseService responseBuilder,
OperationService operationParser,
SpringDocConfigProperties springDocConfigProperties,
SpringDocProviders springDocProviders,
SpringDocCustomizers springDocCustomizers)
Instantiates a new Open api web mvc resource.
|
OpenApiWebMvcResource(String groupName,
org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
AbstractRequestService requestBuilder,
GenericResponseService responseBuilder,
OperationService operationParser,
SpringDocConfigProperties springDocConfigProperties,
SpringDocProviders springDocProviders,
SpringDocCustomizers springDocCustomizers)
Instantiates a new Open api web mvc resource.
|
| Modifier and Type | Method and Description |
|---|---|
protected String |
getServerUrl(javax.servlet.http.HttpServletRequest request,
String apiDocsUrl)
Gets server url.
|
byte[] |
openapiJson(javax.servlet.http.HttpServletRequest request,
String apiDocsUrl,
Locale locale)
Openapi json string.
|
byte[] |
openapiYaml(javax.servlet.http.HttpServletRequest request,
String apiDocsUrl,
Locale locale)
Openapi yaml string.
|
calculatePath, calculateServerUrl, getPathsaddHiddenRestControllers, 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, writeYamlValuepublic OpenApiWebMvcResource(String groupName, org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders, SpringDocCustomizers springDocCustomizers)
groupName - the group nameopenAPIBuilderObjectFactory - the open api builder object factoryrequestBuilder - the request builderresponseBuilder - the response builderoperationParser - the operation parserspringDocConfigProperties - the spring doc config propertiesspringDocProviders - the spring doc providersspringDocCustomizers - the spring doc customizers@Autowired public OpenApiWebMvcResource(org.springframework.beans.factory.ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders, SpringDocCustomizers springDocCustomizers)
openAPIBuilderObjectFactory - the open api builder object factoryrequestBuilder - the request builderresponseBuilder - the response builderoperationParser - the operation parserspringDocConfigProperties - the spring doc config propertiesspringDocProviders - the spring doc providersspringDocCustomizers - the spring doc customizers@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}",
produces="application/json")
public byte[] openapiJson(javax.servlet.http.HttpServletRequest request,
@Value(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}")
String apiDocsUrl,
Locale locale)
throws com.fasterxml.jackson.core.JsonProcessingException
openapiJson in class OpenApiResourcerequest - the requestapiDocsUrl - the api docs urllocale - the localecom.fasterxml.jackson.core.JsonProcessingException - the json processing exception@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml",
produces="application/vnd.oai.openapi")
public byte[] openapiYaml(javax.servlet.http.HttpServletRequest request,
@Value(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml")
String apiDocsUrl,
Locale locale)
throws com.fasterxml.jackson.core.JsonProcessingException
openapiYaml in class OpenApiResourcerequest - the requestapiDocsUrl - the api docs urllocale - the localecom.fasterxml.jackson.core.JsonProcessingException - the json processing exceptionprotected String getServerUrl(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)
getServerUrl in class OpenApiResourcerequest - the requestapiDocsUrl - the api docs urlCopyright © 2024. All rights reserved.