org.springdoc.api

Class AbstractOpenApiResource

java.lang.Object

io.swagger.v3.core.filter.SpecFilter

org.springdoc.api.AbstractOpenApiResource

public abstract class AbstractOpenApiResource
extends io.swagger.v3.core.filter.SpecFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected OpenAPIBuilder	openAPIBuilder
protected SpringDocConfigProperties	springDocConfigProperties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder, GenericResponseBuilder responseBuilder, OperationBuilder operationParser, Optional<List<OpenApiCustomiser>> openApiCustomisers, SpringDocConfigProperties springDocConfigProperties)

Method Summary

Modifier and Type	Method and Description
static void	addDeprecatedType(Class<?> cls)
static void	addHiddenRestControllers(Class<?>... classes)
static void	addRestControllers(Class<?>... classes)
protected void	calculatePath(org.springframework.web.method.HandlerMethod handlerMethod, String operationPath, Set<org.springframework.web.bind.annotation.RequestMethod> requestMethods)
protected String	decode(String requestURI)
protected Set	getDefaultAllowedHttpMethods()
protected io.swagger.v3.oas.models.OpenAPI	getOpenApi()
protected abstract void	getPaths(Map<String,Object> findRestControllers)
protected boolean	isAdditionalRestController(Class<?> rawClass)
protected boolean	isHiddenRestControllers(Class<?> rawClass)
protected boolean	isPackageToScan(String aPackage)
protected boolean	isPathToMatch(String operationPath)

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

openAPIBuilder

protected final OpenAPIBuilder openAPIBuilder

springDocConfigProperties

protected final SpringDocConfigProperties springDocConfigProperties

Constructor Detail

AbstractOpenApiResource

protected AbstractOpenApiResource(String groupName,
                                  OpenAPIBuilder openAPIBuilder,
                                  AbstractRequestBuilder requestBuilder,
                                  GenericResponseBuilder responseBuilder,
                                  OperationBuilder operationParser,
                                  Optional<List<OpenApiCustomiser>> openApiCustomisers,
                                  SpringDocConfigProperties springDocConfigProperties)

Method Detail

addRestControllers

public static void addRestControllers(Class<?>... classes)

addHiddenRestControllers

public static void addHiddenRestControllers(Class<?>... classes)

addDeprecatedType

public static void addDeprecatedType(Class<?> cls)

getOpenApi

protected io.swagger.v3.oas.models.OpenAPI getOpenApi()

getPaths

protected abstract void getPaths(Map<String,Object> findRestControllers)

calculatePath

protected void calculatePath(org.springframework.web.method.HandlerMethod handlerMethod,
                             String operationPath,
                             Set<org.springframework.web.bind.annotation.RequestMethod> requestMethods)

isPackageToScan

protected boolean isPackageToScan(String aPackage)

isPathToMatch

protected boolean isPathToMatch(String operationPath)

decode

protected String decode(String requestURI)

isAdditionalRestController

protected boolean isAdditionalRestController(Class<?> rawClass)

isHiddenRestControllers

protected boolean isHiddenRestControllers(Class<?> rawClass)

getDefaultAllowedHttpMethods

protected Set getDefaultAllowedHttpMethods()