org.springdoc.api

Class OpenApiResource

java.lang.Object

io.swagger.v3.core.filter.SpecFilter

org.springdoc.api.AbstractOpenApiResource

org.springdoc.api.OpenApiResource

@RestController
public class OpenApiResource
extends AbstractOpenApiResource

Field Summary

Fields inherited from class org.springdoc.api.AbstractOpenApiResource

springDocConfigProperties

Constructor Summary

Constructors

Constructor and Description

OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder, GenericResponseBuilder responseBuilder, OperationBuilder operationParser, org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping, Optional<ActuatorProvider> servletContextProvider, Optional<List<OpenApiCustomiser>> openApiCustomisers, SpringDocConfigProperties springDocConfigProperties)

Method Summary

Modifier and Type	Method and Description
protected void	getPaths(Map<String,Object> restControllers)
String	openapiJson(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)
String	openapiYaml(javax.servlet.http.HttpServletRequest request, String apiDocsUrl)

Methods inherited from class org.springdoc.api.AbstractOpenApiResource

addDeprecatedType, addHiddenRestControllers, addRestControllers, calculatePath, decode, getDefaultAllowedHttpMethods, getOpenApi, isAdditionalRestController, isHiddenRestControllers, isPackageToScan, isPathToMatch

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

Constructor Detail

OpenApiResource

public OpenApiResource(String groupName,
                       OpenAPIBuilder openAPIBuilder,
                       AbstractRequestBuilder requestBuilder,
                       GenericResponseBuilder responseBuilder,
                       OperationBuilder operationParser,
                       org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
                       Optional<ActuatorProvider> servletContextProvider,
                       Optional<List<OpenApiCustomiser>> openApiCustomisers,
                       SpringDocConfigProperties springDocConfigProperties)

Method Detail

openapiJson

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}",
            produces="application/json")
public String openapiJson(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                             @Value(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}")
                                                                                                                                                                             String apiDocsUrl)
                                                                                                                                                                      throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

openapiYaml

@GetMapping(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml",
            produces="application/vnd.oai.openapi")
public String openapiYaml(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                             @Value(value="${springdoc.api-docs.path:#{T(org.springdoc.core.Constants).DEFAULT_API_DOCS_URL}}.yaml")
                                                                                                                                                                                             String apiDocsUrl)
                                                                                                                                                                                      throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getPaths

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

Specified by:

getPaths in class AbstractOpenApiResource