org.springdoc.core

Class AbstractRequestBuilder

java.lang.Object

org.springdoc.core.AbstractRequestBuilder

public abstract class AbstractRequestBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<Class>	PARAM_TYPES_TO_IGNORE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRequestBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder, OperationBuilder operationBuilder, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<ParameterCustomizer>> parameterCustomizers)

Method Summary

Modifier and Type	Method and Description
io.swagger.v3.oas.models.Operation	build(io.swagger.v3.oas.models.Components components, org.springframework.web.method.HandlerMethod handlerMethod, org.springframework.web.bind.annotation.RequestMethod requestMethod, io.swagger.v3.oas.models.Operation operation, MethodAttributes methodAttributes)
protected io.swagger.v3.oas.models.Operation	customiseOperation(io.swagger.v3.oas.models.Operation operation, org.springframework.web.method.HandlerMethod handlerMethod)
protected io.swagger.v3.oas.models.parameters.Parameter	customiseParameter(io.swagger.v3.oas.models.parameters.Parameter parameter, org.springdoc.core.ParameterInfo parameterInfo, org.springframework.web.method.HandlerMethod handlerMethod)
RequestBodyBuilder	getRequestBodyBuilder()
protected boolean	isParamToIgnore(Parameter parameter)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_TYPES_TO_IGNORE

protected static final List<Class> PARAM_TYPES_TO_IGNORE

Constructor Detail

AbstractRequestBuilder

protected AbstractRequestBuilder(AbstractParameterBuilder parameterBuilder,
                                 RequestBodyBuilder requestBodyBuilder,
                                 OperationBuilder operationBuilder,
                                 Optional<List<OperationCustomizer>> operationCustomizers,
                                 Optional<List<ParameterCustomizer>> parameterCustomizers)

Method Detail

build

public io.swagger.v3.oas.models.Operation build(io.swagger.v3.oas.models.Components components,
                                                org.springframework.web.method.HandlerMethod handlerMethod,
                                                org.springframework.web.bind.annotation.RequestMethod requestMethod,
                                                io.swagger.v3.oas.models.Operation operation,
                                                MethodAttributes methodAttributes)

customiseOperation

protected io.swagger.v3.oas.models.Operation customiseOperation(io.swagger.v3.oas.models.Operation operation,
                                                                org.springframework.web.method.HandlerMethod handlerMethod)

customiseParameter

protected io.swagger.v3.oas.models.parameters.Parameter customiseParameter(io.swagger.v3.oas.models.parameters.Parameter parameter,
                                                                           org.springdoc.core.ParameterInfo parameterInfo,
                                                                           org.springframework.web.method.HandlerMethod handlerMethod)

isParamToIgnore

protected boolean isParamToIgnore(Parameter parameter)

getRequestBodyBuilder

public RequestBodyBuilder getRequestBodyBuilder()