org.springdoc.api

Class AbstractOpenApiResource

java.lang.Object

org.springdoc.api.AbstractOpenApiResource

public abstract class AbstractOpenApiResource
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder, AbstractResponseBuilder responseBuilder, OperationBuilder operationParser, Optional<List<OpenApiCustomiser>> openApiCustomisers)
protected	AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder, AbstractResponseBuilder responseBuilder, OperationBuilder operationParser, Optional<List<OpenApiCustomiser>> openApiCustomisers, List<String> pathsToMatch, List<String> packagesToScan)

Method Summary

Modifier and Type	Method and Description
protected void	calculatePath(OpenAPIBuilder openAPIBuilder, org.springframework.web.method.HandlerMethod handlerMethod, String operationPath, Set<org.springframework.web.bind.annotation.RequestMethod> requestMethods)
protected io.swagger.v3.oas.models.OpenAPI	getOpenApi()
protected abstract void	getPaths(Map<String,Object> findRestControllers)
protected boolean	isPackageToScan(String aPackage)
protected boolean	isPathToMatch(String operationPath)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractOpenApiResource

protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder,
                                  AbstractRequestBuilder requestBuilder,
                                  AbstractResponseBuilder responseBuilder,
                                  OperationBuilder operationParser,
                                  Optional<List<OpenApiCustomiser>> openApiCustomisers)

AbstractOpenApiResource

protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder,
                                  AbstractRequestBuilder requestBuilder,
                                  AbstractResponseBuilder responseBuilder,
                                  OperationBuilder operationParser,
                                  Optional<List<OpenApiCustomiser>> openApiCustomisers,
                                  List<String> pathsToMatch,
                                  List<String> packagesToScan)

Method Detail

getOpenApi

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

getPaths

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

calculatePath

protected void calculatePath(OpenAPIBuilder openAPIBuilder,
                             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)