org.springdoc.core

Class AbstractRequestBuilder

java.lang.Object

org.springdoc.core.AbstractRequestBuilder

public abstract class AbstractRequestBuilder
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static void	addRequestWrapperToIgnore(Class<?>... classes)
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, io.swagger.v3.oas.models.OpenAPI openAPI)
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(org.springframework.core.MethodParameter parameter)
static void	removeRequestWrapperToIgnore(Class<?>... classes)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRequestBuilder

protected AbstractRequestBuilder(GenericParameterBuilder 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,
                                                io.swagger.v3.oas.models.OpenAPI openAPI)

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(org.springframework.core.MethodParameter parameter)

getRequestBodyBuilder

public RequestBodyBuilder getRequestBodyBuilder()

addRequestWrapperToIgnore

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

removeRequestWrapperToIgnore

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