org.springdoc.webmvc.core.fn

Class SpringdocRouteBuilder

java.lang.Object

org.springdoc.core.fn.AbstractSpringdocRouteBuilder

org.springdoc.webmvc.core.fn.SpringdocRouteBuilder

public class SpringdocRouteBuilder
extends AbstractSpringdocRouteBuilder

The type Springdoc route builder.

Author:

bnasslahsen

Method Summary

Modifier and Type	Method and Description
SpringdocRouteBuilder	add(org.springframework.web.servlet.function.RouterFunction<org.springframework.web.servlet.function.ServerResponse> routerFunction, Consumer<Builder> operationsConsumer) Add springdoc route builder.
SpringdocRouteBuilder	after(BiFunction<org.springframework.web.servlet.function.ServerRequest,org.springframework.web.servlet.function.ServerResponse,org.springframework.web.servlet.function.ServerResponse> responseProcessor, Consumer<Builder> operationsConsumer) After springdoc route builder.
SpringdocRouteBuilder	before(UnaryOperator<org.springframework.web.servlet.function.ServerRequest> requestProcessor, Consumer<Builder> operationsConsumer) Before springdoc route builder.
org.springframework.web.servlet.function.RouterFunction<org.springframework.web.servlet.function.ServerResponse>	build() Build router function.
SpringdocRouteBuilder	DELETE(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Delete springdoc route builder.
SpringdocRouteBuilder	DELETE(org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Delete springdoc route builder.
SpringdocRouteBuilder	DELETE(String pattern, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Delete springdoc route builder.
SpringdocRouteBuilder	DELETE(String pattern, org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Delete springdoc route builder.
SpringdocRouteBuilder	filter(org.springframework.web.servlet.function.HandlerFilterFunction<org.springframework.web.servlet.function.ServerResponse,org.springframework.web.servlet.function.ServerResponse> filterFunction, Consumer<Builder> operationsConsumer) Filter springdoc route builder.
SpringdocRouteBuilder	GET(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Get springdoc route builder.
SpringdocRouteBuilder	GET(org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Get springdoc route builder.
SpringdocRouteBuilder	GET(String pattern, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Get springdoc route builder.
SpringdocRouteBuilder	GET(String pattern, org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Get springdoc route builder.
SpringdocRouteBuilder	HEAD(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Head springdoc route builder.
SpringdocRouteBuilder	HEAD(org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Head springdoc route builder.
SpringdocRouteBuilder	HEAD(String pattern, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Head springdoc route builder.
SpringdocRouteBuilder	HEAD(String pattern, org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Head springdoc route builder.
SpringdocRouteBuilder	nest(org.springframework.web.servlet.function.RequestPredicate predicate, Consumer<org.springframework.web.servlet.function.RouterFunctions.Builder> builderConsumer, Consumer<Builder> operationsConsumer) Nest springdoc route builder.
SpringdocRouteBuilder	nest(org.springframework.web.servlet.function.RequestPredicate predicate, Supplier<org.springframework.web.servlet.function.RouterFunction<org.springframework.web.servlet.function.ServerResponse>> routerFunctionSupplier, Consumer<Builder> operationsConsumer) Nest springdoc route builder.
<T extends Throwable> SpringdocRouteBuilder	onError(Class<T> exceptionType, BiFunction<Throwable,org.springframework.web.servlet.function.ServerRequest,org.springframework.web.servlet.function.ServerResponse> responseProvider) On error springdoc route builder.
SpringdocRouteBuilder	onError(Predicate<Throwable> predicate, BiFunction<Throwable,org.springframework.web.servlet.function.ServerRequest,org.springframework.web.servlet.function.ServerResponse> responseProvider) On error springdoc route builder.
SpringdocRouteBuilder	OPTIONS(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Options springdoc route builder.
SpringdocRouteBuilder	OPTIONS(org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Options springdoc route builder.
SpringdocRouteBuilder	OPTIONS(String pattern, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Options springdoc route builder.
SpringdocRouteBuilder	OPTIONS(String pattern, org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Options springdoc route builder.
SpringdocRouteBuilder	PATCH(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Patch springdoc route builder.
SpringdocRouteBuilder	PATCH(org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Patch springdoc route builder.
SpringdocRouteBuilder	PATCH(String pattern, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Patch springdoc route builder.
SpringdocRouteBuilder	PATCH(String pattern, org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Patch springdoc route builder.
SpringdocRouteBuilder	path(String pattern, Consumer<org.springframework.web.servlet.function.RouterFunctions.Builder> builderConsumer, Consumer<Builder> operationsConsumer) Path springdoc route builder.
SpringdocRouteBuilder	path(String pattern, Supplier<org.springframework.web.servlet.function.RouterFunction<org.springframework.web.servlet.function.ServerResponse>> routerFunctionSupplier, Consumer<Builder> operationsConsumer) Path springdoc route builder.
SpringdocRouteBuilder	POST(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Post springdoc route builder.
SpringdocRouteBuilder	POST(org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Post springdoc route builder.
SpringdocRouteBuilder	POST(String pattern, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Post springdoc route builder.
SpringdocRouteBuilder	POST(String pattern, org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Post springdoc route builder.
SpringdocRouteBuilder	PUT(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Put springdoc route builder.
SpringdocRouteBuilder	PUT(org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Put springdoc route builder.
SpringdocRouteBuilder	PUT(String pattern, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Put springdoc route builder.
SpringdocRouteBuilder	PUT(String pattern, org.springframework.web.servlet.function.RequestPredicate predicate, org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction, Consumer<Builder> operationsConsumer) Put springdoc route builder.
SpringdocRouteBuilder	resources(Function<org.springframework.web.servlet.function.ServerRequest,Optional<org.springframework.core.io.Resource>> lookupFunction, Consumer<Builder> operationsConsumer) Resources springdoc route builder.
SpringdocRouteBuilder	resources(String pattern, org.springframework.core.io.Resource location, Consumer<Builder> operationsConsumer) Resources springdoc route builder.
static SpringdocRouteBuilder	route() Route springdoc route builder.

Methods inherited from class org.springdoc.core.fn.AbstractSpringdocRouteBuilder

getOperationBuilder

Methods inherited from class java.lang.Object

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

Method Detail

route

public static SpringdocRouteBuilder route()

Route springdoc route builder.

Returns:

the springdoc route builder

build

public org.springframework.web.servlet.function.RouterFunction<org.springframework.web.servlet.function.ServerResponse> build()

Build router function.

Returns:

the router function

GET

public SpringdocRouteBuilder GET(String pattern,
                                 org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                 Consumer<Builder> operationsConsumer)

Get springdoc route builder.

Parameters:

pattern - the pattern

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

GET

public SpringdocRouteBuilder GET(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                 Consumer<Builder> operationsConsumer)

Get springdoc route builder.

Parameters:

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

GET

public SpringdocRouteBuilder GET(org.springframework.web.servlet.function.RequestPredicate predicate,
                                 org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                 Consumer<Builder> operationsConsumer)

Get springdoc route builder.

Parameters:

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

GET

public SpringdocRouteBuilder GET(String pattern,
                                 org.springframework.web.servlet.function.RequestPredicate predicate,
                                 org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                 Consumer<Builder> operationsConsumer)

Get springdoc route builder.

Parameters:

pattern - the pattern

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

HEAD

public SpringdocRouteBuilder HEAD(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                  Consumer<Builder> operationsConsumer)

Head springdoc route builder.

Parameters:

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

HEAD

public SpringdocRouteBuilder HEAD(String pattern,
                                  org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                  Consumer<Builder> operationsConsumer)

Head springdoc route builder.

Parameters:

pattern - the pattern

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

HEAD

public SpringdocRouteBuilder HEAD(org.springframework.web.servlet.function.RequestPredicate predicate,
                                  org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                  Consumer<Builder> operationsConsumer)

Head springdoc route builder.

Parameters:

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

HEAD

public SpringdocRouteBuilder HEAD(String pattern,
                                  org.springframework.web.servlet.function.RequestPredicate predicate,
                                  org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                  Consumer<Builder> operationsConsumer)

Head springdoc route builder.

Parameters:

pattern - the pattern

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

POST

public SpringdocRouteBuilder POST(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                  Consumer<Builder> operationsConsumer)

Post springdoc route builder.

Parameters:

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

POST

public SpringdocRouteBuilder POST(String pattern,
                                  org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                  Consumer<Builder> operationsConsumer)

Post springdoc route builder.

Parameters:

pattern - the pattern

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

POST

public SpringdocRouteBuilder POST(org.springframework.web.servlet.function.RequestPredicate predicate,
                                  org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                  Consumer<Builder> operationsConsumer)

Post springdoc route builder.

Parameters:

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

POST

public SpringdocRouteBuilder POST(String pattern,
                                  org.springframework.web.servlet.function.RequestPredicate predicate,
                                  org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                  Consumer<Builder> operationsConsumer)

Post springdoc route builder.

Parameters:

pattern - the pattern

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

PUT

public SpringdocRouteBuilder PUT(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                 Consumer<Builder> operationsConsumer)

Put springdoc route builder.

Parameters:

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

PUT

public SpringdocRouteBuilder PUT(String pattern,
                                 org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                 Consumer<Builder> operationsConsumer)

Put springdoc route builder.

Parameters:

pattern - the pattern

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

PUT

public SpringdocRouteBuilder PUT(org.springframework.web.servlet.function.RequestPredicate predicate,
                                 org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                 Consumer<Builder> operationsConsumer)

Put springdoc route builder.

Parameters:

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

PUT

public SpringdocRouteBuilder PUT(String pattern,
                                 org.springframework.web.servlet.function.RequestPredicate predicate,
                                 org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                 Consumer<Builder> operationsConsumer)

Put springdoc route builder.

Parameters:

pattern - the pattern

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

PATCH

public SpringdocRouteBuilder PATCH(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                   Consumer<Builder> operationsConsumer)

Patch springdoc route builder.

Parameters:

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

PATCH

public SpringdocRouteBuilder PATCH(String pattern,
                                   org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                   Consumer<Builder> operationsConsumer)

Patch springdoc route builder.

Parameters:

pattern - the pattern

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

PATCH

public SpringdocRouteBuilder PATCH(org.springframework.web.servlet.function.RequestPredicate predicate,
                                   org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                   Consumer<Builder> operationsConsumer)

Patch springdoc route builder.

Parameters:

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

PATCH

public SpringdocRouteBuilder PATCH(String pattern,
                                   org.springframework.web.servlet.function.RequestPredicate predicate,
                                   org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                   Consumer<Builder> operationsConsumer)

Patch springdoc route builder.

Parameters:

pattern - the pattern

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

DELETE

public SpringdocRouteBuilder DELETE(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                    Consumer<Builder> operationsConsumer)

Delete springdoc route builder.

Parameters:

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

DELETE

public SpringdocRouteBuilder DELETE(String pattern,
                                    org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                    Consumer<Builder> operationsConsumer)

Delete springdoc route builder.

Parameters:

pattern - the pattern

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

DELETE

public SpringdocRouteBuilder DELETE(org.springframework.web.servlet.function.RequestPredicate predicate,
                                    org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                    Consumer<Builder> operationsConsumer)

Delete springdoc route builder.

Parameters:

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

DELETE

public SpringdocRouteBuilder DELETE(String pattern,
                                    org.springframework.web.servlet.function.RequestPredicate predicate,
                                    org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                    Consumer<Builder> operationsConsumer)

Delete springdoc route builder.

Parameters:

pattern - the pattern

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

OPTIONS

public SpringdocRouteBuilder OPTIONS(org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                     Consumer<Builder> operationsConsumer)

Options springdoc route builder.

Parameters:

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

OPTIONS

public SpringdocRouteBuilder OPTIONS(String pattern,
                                     org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                     Consumer<Builder> operationsConsumer)

Options springdoc route builder.

Parameters:

pattern - the pattern

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

OPTIONS

public SpringdocRouteBuilder OPTIONS(org.springframework.web.servlet.function.RequestPredicate predicate,
                                     org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                     Consumer<Builder> operationsConsumer)

Options springdoc route builder.

Parameters:

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

OPTIONS

public SpringdocRouteBuilder OPTIONS(String pattern,
                                     org.springframework.web.servlet.function.RequestPredicate predicate,
                                     org.springframework.web.servlet.function.HandlerFunction<org.springframework.web.servlet.function.ServerResponse> handlerFunction,
                                     Consumer<Builder> operationsConsumer)

Options springdoc route builder.

Parameters:

pattern - the pattern

predicate - the predicate

handlerFunction - the handler function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

add

public SpringdocRouteBuilder add(org.springframework.web.servlet.function.RouterFunction<org.springframework.web.servlet.function.ServerResponse> routerFunction,
                                 Consumer<Builder> operationsConsumer)

Add springdoc route builder.

Parameters:

routerFunction - the router function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

resources

public SpringdocRouteBuilder resources(String pattern,
                                       org.springframework.core.io.Resource location,
                                       Consumer<Builder> operationsConsumer)

Resources springdoc route builder.

Parameters:

pattern - the pattern

location - the location

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

resources

public SpringdocRouteBuilder resources(Function<org.springframework.web.servlet.function.ServerRequest,Optional<org.springframework.core.io.Resource>> lookupFunction,
                                       Consumer<Builder> operationsConsumer)

Resources springdoc route builder.

Parameters:

lookupFunction - the lookup function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

nest

public SpringdocRouteBuilder nest(org.springframework.web.servlet.function.RequestPredicate predicate,
                                  Supplier<org.springframework.web.servlet.function.RouterFunction<org.springframework.web.servlet.function.ServerResponse>> routerFunctionSupplier,
                                  Consumer<Builder> operationsConsumer)

Nest springdoc route builder.

Parameters:

predicate - the predicate

routerFunctionSupplier - the router function supplier

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

nest

public SpringdocRouteBuilder nest(org.springframework.web.servlet.function.RequestPredicate predicate,
                                  Consumer<org.springframework.web.servlet.function.RouterFunctions.Builder> builderConsumer,
                                  Consumer<Builder> operationsConsumer)

Nest springdoc route builder.

Parameters:

predicate - the predicate

builderConsumer - the builder consumer

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

path

public SpringdocRouteBuilder path(String pattern,
                                  Supplier<org.springframework.web.servlet.function.RouterFunction<org.springframework.web.servlet.function.ServerResponse>> routerFunctionSupplier,
                                  Consumer<Builder> operationsConsumer)

Path springdoc route builder.

Parameters:

pattern - the pattern

routerFunctionSupplier - the router function supplier

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

path

public SpringdocRouteBuilder path(String pattern,
                                  Consumer<org.springframework.web.servlet.function.RouterFunctions.Builder> builderConsumer,
                                  Consumer<Builder> operationsConsumer)

Path springdoc route builder.

Parameters:

pattern - the pattern

builderConsumer - the builder consumer

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

filter

public SpringdocRouteBuilder filter(org.springframework.web.servlet.function.HandlerFilterFunction<org.springframework.web.servlet.function.ServerResponse,org.springframework.web.servlet.function.ServerResponse> filterFunction,
                                    Consumer<Builder> operationsConsumer)

Filter springdoc route builder.

Parameters:

filterFunction - the filter function

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

before

public SpringdocRouteBuilder before(UnaryOperator<org.springframework.web.servlet.function.ServerRequest> requestProcessor,
                                    Consumer<Builder> operationsConsumer)

Before springdoc route builder.

Parameters:

requestProcessor - the request processor

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

after

public SpringdocRouteBuilder after(BiFunction<org.springframework.web.servlet.function.ServerRequest,org.springframework.web.servlet.function.ServerResponse,org.springframework.web.servlet.function.ServerResponse> responseProcessor,
                                   Consumer<Builder> operationsConsumer)

After springdoc route builder.

Parameters:

responseProcessor - the response processor

operationsConsumer - the operations consumer

Returns:

the springdoc route builder

onError

public SpringdocRouteBuilder onError(Predicate<Throwable> predicate,
                                     BiFunction<Throwable,org.springframework.web.servlet.function.ServerRequest,org.springframework.web.servlet.function.ServerResponse> responseProvider)

On error springdoc route builder.

Parameters:

predicate - the predicate

responseProvider - the response provider

Returns:

the springdoc route builder

onError

public <T extends Throwable> SpringdocRouteBuilder onError(Class<T> exceptionType,
                                                           BiFunction<Throwable,org.springframework.web.servlet.function.ServerRequest,org.springframework.web.servlet.function.ServerResponse> responseProvider)

On error springdoc route builder.

Type Parameters:

T - the type parameter

Parameters:

exceptionType - the exception type

responseProvider - the response provider

Returns:

the springdoc route builder