io.vertx.ext.web.openapi.impl

Class OpenAPI3RouterBuilderImpl

java.lang.Object

io.vertx.ext.web.openapi.impl.OpenAPI3RouterBuilderImpl

All Implemented Interfaces:

RouterBuilder

public class OpenAPI3RouterBuilderImpl
extends Object
implements RouterBuilder

Author:

Francesco Guardiani @slinkydeveloper

Constructor Summary

Constructors

Constructor and Description
OpenAPI3RouterBuilderImpl(Vertx vertx, HttpClient client, OpenAPIHolderImpl spec, OpenAPILoaderOptions options)

Method Summary

Modifier and Type	Method and Description
RouterBuilder	bodyHandler(BodyHandler bodyHandler) Supply your own BodyHandler if you would like to control body limit, uploads directory and deletion of uploaded files.
Router	createRouter() Construct a new router based on spec.
OpenAPIHolder	getOpenAPI()
RouterBuilderOptions	getOptions()
SchemaParser	getSchemaParser()
SchemaRouter	getSchemaRouter()
RouterBuilder	mountServiceInterface(Class interfaceClass, String address) Introspect the Web Api Service interface to route to service all matching method names with operation ids.
RouterBuilder	mountServicesFromExtensions() Introspect the OpenAPI spec to mount handlers for all operations that specifies a x-vertx-event-bus annotation.
Operation	operation(String operationId) Access to an operation defined in the contract with operationId
List<Operation>	operations()
RouterBuilder	rootHandler(Handler<RoutingContext> rootHandler) Add global handler to be applied prior to Router being generated.
RouterBuilder	securityHandler(String securitySchemaName, AuthenticationHandler handler) Mount to paths that have to follow a security schema a security handler
RouterBuilder	serviceExtraPayloadMapper(Function<RoutingContext,JsonObject> serviceExtraPayloadMapper) When set, this function is called while creating the payload of ServiceRequest
RouterBuilder	setOptions(RouterBuilderOptions options) Set options of router builder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.web.openapi.RouterBuilder

create, create, create, create

Constructor Detail

OpenAPI3RouterBuilderImpl

public OpenAPI3RouterBuilderImpl(Vertx vertx,
                                 HttpClient client,
                                 OpenAPIHolderImpl spec,
                                 OpenAPILoaderOptions options)

Method Detail

setOptions

public RouterBuilder setOptions(RouterBuilderOptions options)

Description copied from interface: RouterBuilder

Set options of router builder. For more info RouterBuilderOptions

Specified by:

setOptions in interface RouterBuilder

Returns:

self

getOptions

public RouterBuilderOptions getOptions()

Specified by:

getOptions in interface RouterBuilder

Returns:

options of router builder. For more info RouterBuilderOptions

getOpenAPI

public OpenAPIHolder getOpenAPI()

Specified by:

getOpenAPI in interface RouterBuilder

Returns:

holder used by self to process the OpenAPI. You can use it to resolve $refs

getSchemaRouter

public SchemaRouter getSchemaRouter()

Specified by:

getSchemaRouter in interface RouterBuilder

Returns:

schema router used by self to internally manage all Schema instances

getSchemaParser

public SchemaParser getSchemaParser()

Specified by:

getSchemaParser in interface RouterBuilder

Returns:

schema parser used by self to parse all Schema

serviceExtraPayloadMapper

public RouterBuilder serviceExtraPayloadMapper(Function<RoutingContext,JsonObject> serviceExtraPayloadMapper)

Description copied from interface: RouterBuilder

When set, this function is called while creating the payload of ServiceRequest

Specified by:

serviceExtraPayloadMapper in interface RouterBuilder

Returns:

self

securityHandler

public RouterBuilder securityHandler(String securitySchemaName,
                                     AuthenticationHandler handler)

Description copied from interface: RouterBuilder

Mount to paths that have to follow a security schema a security handler

Specified by:

securityHandler in interface RouterBuilder

Returns:

self

operations

public List<Operation> operations()

Specified by:

operations in interface RouterBuilder

Returns:

all operations defined in the contract

operation

public Operation operation(String operationId)

Description copied from interface: RouterBuilder

Access to an operation defined in the contract with operationId

Specified by:

operation in interface RouterBuilder

Parameters:

operationId - the id of the operation

Returns:

the requested operation

bodyHandler

public RouterBuilder bodyHandler(BodyHandler bodyHandler)

Description copied from interface: RouterBuilder

Supply your own BodyHandler if you would like to control body limit, uploads directory and deletion of uploaded files. If you provide a null body handler, you won't be able to validate request bodies

Specified by:

bodyHandler in interface RouterBuilder

Returns:

self

rootHandler

public RouterBuilder rootHandler(Handler<RoutingContext> rootHandler)

Description copied from interface: RouterBuilder

Add global handler to be applied prior to Router being generated.
Please note that you should not add a body handler inside that list. If you want to modify the body handler, please use RouterBuilder.bodyHandler(BodyHandler)

Specified by:

rootHandler in interface RouterBuilder

Returns:

self

mountServiceInterface

public RouterBuilder mountServiceInterface(Class interfaceClass,
                                           String address)

Description copied from interface: RouterBuilder

Introspect the Web Api Service interface to route to service all matching method names with operation ids. Please give a look at vertx-web-api-service documentation for more informations

Specified by:

mountServiceInterface in interface RouterBuilder

Returns:

self

mountServicesFromExtensions

public RouterBuilder mountServicesFromExtensions()

Description copied from interface: RouterBuilder

Introspect the OpenAPI spec to mount handlers for all operations that specifies a x-vertx-event-bus annotation. Please give a look at vertx-web-api-service documentation for more informations

Specified by:

mountServicesFromExtensions in interface RouterBuilder

Returns:

self

createRouter

public Router createRouter()

Description copied from interface: RouterBuilder

Construct a new router based on spec. It will fail if you are trying to mount a spec with security schemes without assigned handlers
Note: Router is built when this function is called and the path definition ordering in contract is respected.

Specified by:

createRouter in interface RouterBuilder

Returns: