vertx / io.vertx.ext.web.api.contract / DesignDrivenRouterFactory

# DesignDrivenRouterFactory

`interface DesignDrivenRouterFactory<Specification : Any>`

Main interface for Design Driven Router factory Author: Francesco Guardiani @slinkydeveloper

### Functions

addFailureHandler | `abstract fun addFailureHandler(method: HttpMethod, path: String, failureHandler: Handler<RoutingContext>): DesignDrivenRouterFactory<Any>` Add a failure handler to a path with a method. If combination path/method is not available in specification, it will throw a RouterFactoryException
addHandler | `abstract fun addHandler(method: HttpMethod, path: String, handler: Handler<RoutingContext>): DesignDrivenRouterFactory<Any>` Add an handler to a path with a method. If combination path/method is not available in specification, it will throw a RouterFactoryException
addSecurityHandler | `abstract fun addSecurityHandler(securitySchemaName: String, handler: Handler<RoutingContext>): DesignDrivenRouterFactory<Any>` Mount to paths that have to follow a security schema a security handler
enableValidationFailureHandler | `abstract fun enableValidationFailureHandler(enable: Boolean): DesignDrivenRouterFactory<Any>` Enable or disable validation failure handler. If you enable it, during router creation it will be mounted a built-in (or custom with function `DesignDrivenRouterFactory#setValidationFailureHandler(Handler)`) ValidationException handler as a failure handler. If failure is different from ValidationException, it will be called the next failure handler.
getRouter | `abstract fun getRouter(): Router` 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 constructed in this function, so it will be respected the path definition ordering.
mountOperationsWithoutHandlers | `abstract fun mountOperationsWithoutHandlers(enable: Boolean): DesignDrivenRouterFactory<Any>` Automatic mount handlers that return HTTP 501 status code for operations where you didn't specify an handler.
setValidationFailureHandler | `abstract fun setValidationFailureHandler(handler: Handler<RoutingContext>): DesignDrivenRouterFactory<Any>` Set default validation failure handler. You can disable this feature from `DesignDrivenRouterFactory#enableValidationFailureHandler(boolean)`

### Inheritors

OpenAPI3RouterFactory | `interface OpenAPI3RouterFactory : DesignDrivenRouterFactory<OpenAPI>` Interface for OpenAPI3RouterFactory. To add an handler, use `OpenAPI3RouterFactory#addHandlerByOperationId(String, Handler)`, in this class is better than generic `DesignDrivenRouterFactory#addHandler(HttpMethod, String, Handler)` If you want to use `DesignDrivenRouterFactory#addHandler(HttpMethod, String, Handler)` remember that you have to pass path as declared in openapi specification Usage example:
    OpenAPI3RouterFactory.createRouterFactoryFromFile(vertx, "src/resources/spec.yaml", asyncResult -> { if (!asyncResult.succeeded()) { // IO failure or spec invalid } else { OpenAPI3RouterFactory routerFactory = asyncResult.result(); routerFactory.addHandlerByOperationId("operation_id", routingContext -> { // Do something }, routingContext -> { // Do something with failure handler }); Router router = routerFactory.getRouter(); } });