A C D E G H I K O R S W
All Classes All Packages

A

addFailureHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

Adds a failure handler for this route

addHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

Adds a handler for this route which is executed after the security and validation handlers defined in the contract

apiKeyHandler(APIKeyHandler) - Method in interface io.vertx.ext.web.openapi.router.Security

Configure the APIKeyHandler to be used when creating the router.

C

create(Vertx, OpenAPIContract) - Static method in interface io.vertx.ext.web.openapi.router.RouterBuilder

Create a new RouterBuilder.

create(Vertx, OpenAPIContract, RequestExtractor) - Static method in interface io.vertx.ext.web.openapi.router.RouterBuilder

Create a new RouterBuilder.

createRouter() - Method in interface io.vertx.ext.web.openapi.router.RouterBuilder

Construct a new router based on the related OpenAPI contract.

D

doSecurity() - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

doValidation() - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

E

extractValidatableRequest(RoutingContext, Operation) - Method in interface io.vertx.ext.web.openapi.router.RequestExtractor

Extracts and transforms the parameters and the body of an incoming request into a format that can be validated by the RequestValidator.

G

getFailureHandlers() - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

getHandlers() - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

getOperation() - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

getRoute(String) - Method in interface io.vertx.ext.web.openapi.router.RouterBuilder

Access to a route defined in the contract with operationId

getRoutes() - Method in interface io.vertx.ext.web.openapi.router.RouterBuilder

H

httpHandler(BasicAuthHandler) - Method in interface io.vertx.ext.web.openapi.router.Security

Configure the BasicAuthHandler to be used when creating the router.

httpHandler(DigestAuthHandler) - Method in interface io.vertx.ext.web.openapi.router.Security

Configure the DigestAuthHandler to be used when creating the router.

httpHandler(JWTAuthHandler) - Method in interface io.vertx.ext.web.openapi.router.Security

Configure the JWTAuthHandler to be used when creating the router.

I

io.vertx.ext.web.openapi.router - package io.vertx.ext.web.openapi.router

io.vertx.web.openapi.router - module io.vertx.web.openapi.router

K

KEY_META_DATA_OPERATION - Static variable in interface io.vertx.ext.web.openapi.router.RouterBuilder

KEY_META_DATA_VALIDATED_REQUEST - Static variable in interface io.vertx.ext.web.openapi.router.RouterBuilder

O

oauth2Handler(String, Function<SecurityScheme, OAuth2AuthHandler>) - Method in interface io.vertx.ext.web.openapi.router.Security

Configure the OAuth2AuthHandler to be used when creating the router.

oauth2Handler(Function<SecurityScheme, OAuth2AuthHandler>) - Method in interface io.vertx.ext.web.openapi.router.Security

Configure the OAuth2AuthHandler to be used when creating the router.

OpenAPIRoute - Interface in io.vertx.ext.web.openapi.router

openIdConnectHandler(String, Function<String, Future<OAuth2AuthHandler>>) - Method in interface io.vertx.ext.web.openapi.router.Security

Configure the OAuth2AuthHandler to be used when creating the router.

openIdConnectHandler(Function<String, Future<OAuth2AuthHandler>>) - Method in interface io.vertx.ext.web.openapi.router.Security

Configure the OAuth2AuthHandler to be used when creating the router.

R

RequestExtractor - Interface in io.vertx.ext.web.openapi.router

rootHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.openapi.router.RouterBuilder

Add global handler to be applied prior to Router being generated.

RouterBuilder - Interface in io.vertx.ext.web.openapi.router

Interface to build a Vert.x Web Router from an OpenAPI 3 contract.

S

security(String) - Method in interface io.vertx.ext.web.openapi.router.RouterBuilder

Creates a new security scheme for the required AuthenticationHandler.

Security - Interface in io.vertx.ext.web.openapi.router

An authentication handler factory.

setDoSecurity(boolean) - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

Sets the security flag for incoming requests.

setDoValidation(boolean) - Method in interface io.vertx.ext.web.openapi.router.OpenAPIRoute

Sets the validation flag for incoming requests.

W

withBodyHandler() - Static method in interface io.vertx.ext.web.openapi.router.RequestExtractor

A C D E G H I K O R S W
All Classes All Packages