A B C D E F G H I M O P R S T V

A

apply(Operation) - Method in enum io.vertx.ext.web.openapi.RouteNamingStrategy

B

bind(Function<JsonObject, Future<AuthenticationHandler>>) - Method in interface io.vertx.ext.web.openapi.SecurityScheme

bindBlocking(Function<JsonObject, AuthenticationHandler>) - Method in interface io.vertx.ext.web.openapi.SecurityScheme

bodyHandler(BodyHandler) - Method in interface io.vertx.ext.web.openapi.RouterBuilder

Deprecated.

Use RouterBuilder.rootHandler(Handler) instead. The order matters, so adding the body handler should happen after any PLATFORM or SECURITY_POLICY handler(s).

C

cannotFindParameterProcessorGenerator(JsonPointer, JsonObject) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

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

Create a new RouterBuilder

create(Vertx, String, Handler<AsyncResult<RouterBuilder>>) - Static method in interface io.vertx.ext.web.openapi.RouterBuilder

Like this#create(Vertx, String)

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

Create a new RouterBuilder

create(Vertx, String, OpenAPILoaderOptions, Handler<AsyncResult<RouterBuilder>>) - Static method in interface io.vertx.ext.web.openapi.RouterBuilder

Like this#create(Vertx, String, OpenAPILoaderOptions)

createBodyNotSupported(JsonPointer) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

createErrorWhileGeneratingValidationHandler(String, Throwable) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

createInvalidSpec(String, Throwable) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

createInvalidSpec(Throwable) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

createInvalidSpecFile(String, Throwable) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

createMissingSecurityHandler(String) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

createMissingSecurityHandler(String, String) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

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

Construct a new router based on spec.

createRouterBuilderInstantiationError(Throwable, String) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

createUnsupportedSpecFeature(String) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

createWrongExtension(String) - Static method in exception io.vertx.ext.web.openapi.RouterBuilderException

D

DEFAULT_CONTRACT_ENDPOINT - Static variable in class io.vertx.ext.web.openapi.RouterBuilderOptions

By default, RouterBuilder won't serve the contract

DEFAULT_MOUNT_NOT_IMPLEMENTED_HANDLER - Static variable in class io.vertx.ext.web.openapi.RouterBuilderOptions

By default, RouterBuilder mounts Not Implemented/Method Not Allowed handler

DEFAULT_MOUNT_RESPONSE_CONTENT_TYPE_HANDLER - Static variable in class io.vertx.ext.web.openapi.RouterBuilderOptions

By default, RouterBuilder will mount ResponseContentTypeHandler when required

DEFAULT_OPERATION_MODEL_KEY - Static variable in class io.vertx.ext.web.openapi.RouterBuilderOptions

By default, RouterBuilder will not expose operation configuration in the the routing context

DEFAULT_REQUIRE_SECURITY_HANDLERS - Static variable in class io.vertx.ext.web.openapi.RouterBuilderOptions

By default, RouterBuilder requires security handlers to be defined while calling getRouter() or it will throw an Exception

DEFAULT_ROUTE_NAMING_STRATEGY - Static variable in class io.vertx.ext.web.openapi.RouterBuilderOptions

By default, RouterBuilder will name routes by open api path.

E

ErrorType - Enum in io.vertx.ext.web.openapi

F

failureHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.openapi.Operation

Mount a failure handler for this operation

G

getAuthHeaders() - Method in class io.vertx.ext.web.openapi.OpenAPILoaderOptions

getAuthQueryParams() - Method in class io.vertx.ext.web.openapi.OpenAPILoaderOptions

getCached(JsonPointer) - Method in interface io.vertx.ext.web.openapi.OpenAPIHolder

Get cached object using pointer

getContractEndpoint() - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

getHttpMethod() - Method in interface io.vertx.ext.web.openapi.Operation

getOpenAPI() - Method in interface io.vertx.ext.web.openapi.OpenAPIHolder

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

getOpenAPIPath() - Method in interface io.vertx.ext.web.openapi.Operation

getOperationId() - Method in interface io.vertx.ext.web.openapi.Operation

getOperationModel() - Method in interface io.vertx.ext.web.openapi.Operation

getOperationModelKey() - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

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

getRouteNamingStrategy() - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

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

Deprecated.

This method exposes the internal of the OpenAPI handler, it will be removed in the future. Users should configure the json schema module from the options.

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

Deprecated.

This method exposes the internal of the OpenAPI handler, it will be removed in the future. Users should configure the json schema module from the options.

H

handler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.openapi.Operation

Mount an handler for this operation

I

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

isMountNotImplementedHandler() - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

isMountResponseContentTypeHandler() - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

isRequireSecurityHandlers() - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

M

mountServiceInterface(Class, String) - Method in interface io.vertx.ext.web.openapi.RouterBuilder

Introspect the Web Api Service interface to route to service all matching method names with operation ids.

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

Introspect the OpenAPI spec to mount handlers for all operations that specifies a x-vertx-event-bus annotation.

O

OpenAPIHolder - Interface in io.vertx.ext.web.openapi

OpenAPILoaderOptions - Class in io.vertx.ext.web.openapi

OpenAPILoaderOptions() - Constructor for class io.vertx.ext.web.openapi.OpenAPILoaderOptions

OpenAPILoaderOptions(JsonObject) - Constructor for class io.vertx.ext.web.openapi.OpenAPILoaderOptions

OpenAPILoaderOptionsConverter - Class in io.vertx.ext.web.openapi

Converter and mapper for OpenAPILoaderOptions.

OpenAPILoaderOptionsConverter() - Constructor for class io.vertx.ext.web.openapi.OpenAPILoaderOptionsConverter

Operation - Interface in io.vertx.ext.web.openapi

Interface representing an Operation

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

Access to an operation defined in the contract with operationId

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

P

putAuthHeader(String, String) - Method in class io.vertx.ext.web.openapi.OpenAPILoaderOptions

putAuthQueryParam(String, String) - Method in class io.vertx.ext.web.openapi.OpenAPILoaderOptions

R

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

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

RouteNamingStrategy - Enum in io.vertx.ext.web.openapi

The way an OpenAPI operation is transformed into a route name.

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

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

RouterBuilderException - Exception in io.vertx.ext.web.openapi

Main class for router builder exceptions

RouterBuilderException(String, ErrorType, Throwable) - Constructor for exception io.vertx.ext.web.openapi.RouterBuilderException

RouterBuilderOptions - Class in io.vertx.ext.web.openapi

RouterBuilderOptions() - Constructor for class io.vertx.ext.web.openapi.RouterBuilderOptions

RouterBuilderOptions(JsonObject) - Constructor for class io.vertx.ext.web.openapi.RouterBuilderOptions

RouterBuilderOptions(RouterBuilderOptions) - Constructor for class io.vertx.ext.web.openapi.RouterBuilderOptions

RouterBuilderOptionsConverter - Class in io.vertx.ext.web.openapi

Converter and mapper for RouterBuilderOptions.

RouterBuilderOptionsConverter() - Constructor for class io.vertx.ext.web.openapi.RouterBuilderOptionsConverter

routeToEventBus(String) - Method in interface io.vertx.ext.web.openapi.Operation

Route an incoming request to this operation to a Web API Service

routeToEventBus(String, DeliveryOptions) - Method in interface io.vertx.ext.web.openapi.Operation

Route an incoming request to this operation to a Web API Service

S

securityHandler(String, AuthenticationHandler) - Method in interface io.vertx.ext.web.openapi.RouterBuilder

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

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

Creates a new security scheme for the required AuthenticationHandler.

SecurityScheme - Interface in io.vertx.ext.web.openapi

An authentication handler factory.

serviceExtraPayloadMapper(Function<RoutingContext, JsonObject>) - Method in interface io.vertx.ext.web.openapi.RouterBuilder

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

setContractEndpoint(String) - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

Configures the endpoint where the contract is served.

setMountNotImplementedHandler(boolean) - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

If true, Router builder will automatically mount an handler that return HTTP 405/501 status code for each operation where you didn't specify an handler.

setMountResponseContentTypeHandler(boolean) - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

If true, when required, the factory will mount a ResponseContentTypeHandler

setOperationModelKey(String) - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

When set, an additional handler will be created to expose the operation model in the routing context under the given key.

setOptions(RouterBuilderOptions) - Method in interface io.vertx.ext.web.openapi.RouterBuilder

Set options of router builder.

setRequireSecurityHandlers(boolean) - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

If true, when you call RouterBuilder.createRouter() ()} the factory will mount for every path the required security handlers and, if a security handler is not defined, it throws an RouterBuilderException

setRouteNamingStrategy(RouteNamingStrategy) - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

The strategy to follow when naming the generated routes.

solveIfNeeded(JsonObject) - Method in interface io.vertx.ext.web.openapi.OpenAPIHolder

if obj contains $ref, it tries to solve it and return the resolved object, otherwise it returns obj

STANDARD_CONTRACT_ENDPOINT - Static variable in class io.vertx.ext.web.openapi.RouterBuilderOptions

Standard OpenAPI contract endpoint as defined by Microprofile OpenAPI spec

T

toJson() - Method in class io.vertx.ext.web.openapi.OpenAPILoaderOptions

toJson() - Method in class io.vertx.ext.web.openapi.RouterBuilderOptions

toSchemaRouterOptions() - Method in class io.vertx.ext.web.openapi.OpenAPILoaderOptions

type() - Method in exception io.vertx.ext.web.openapi.RouterBuilderException

V

valueOf(String) - Static method in enum io.vertx.ext.web.openapi.ErrorType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.vertx.ext.web.openapi.RouteNamingStrategy

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.vertx.ext.web.openapi.ErrorType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.vertx.ext.web.openapi.RouteNamingStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I M O P R S T V