org.springdoc.api

Class AbstractOpenApiResource

java.lang.Object

org.springdoc.api.AbstractOpenApiResource

public abstract class AbstractOpenApiResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected GeneralInfoBuilder	generalInfoBuilder
protected static org.slf4j.Logger	LOGGER
protected OpenAPIBuilder	openAPIBuilder
protected Optional<List<OpenApiCustomiser>>	openApiCustomisers
protected OperationBuilder	operationParser
protected RequestBodyBuilder	requestBodyBuilder
protected AbstractRequestBuilder	requestBuilder
protected AbstractResponseBuilder	responseBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder, AbstractResponseBuilder responseBuilder, OperationBuilder operationParser, RequestBodyBuilder requestBodyBuilder, GeneralInfoBuilder generalInfoBuilder, Optional<List<OpenApiCustomiser>> openApiCustomisers)

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)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

openAPIBuilder

protected OpenAPIBuilder openAPIBuilder

requestBuilder

protected AbstractRequestBuilder requestBuilder

responseBuilder

protected AbstractResponseBuilder responseBuilder

operationParser

protected OperationBuilder operationParser

requestBodyBuilder

protected RequestBodyBuilder requestBodyBuilder

generalInfoBuilder

protected GeneralInfoBuilder generalInfoBuilder

openApiCustomisers

protected Optional<List<OpenApiCustomiser>> openApiCustomisers

Constructor Detail

AbstractOpenApiResource

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

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)