interface DesignDrivenRouterFactory<Specification : Any>
Main interface for Design Driven Router factory Author: Francesco Guardiani @slinkydeveloper
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 |
|
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 |
|
abstract fun addSecurityHandler(securitySchemaName: String, handler: Handler<RoutingContext>): DesignDrivenRouterFactory<Any>
Mount to paths that have to follow a security schema a security handler |
|
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 |
|
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. |
|
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. |
|
abstract fun setValidationFailureHandler(handler: Handler<RoutingContext>): DesignDrivenRouterFactory<Any>
Set default validation failure handler. You can disable this feature from |
interface OpenAPI3RouterFactory : DesignDrivenRouterFactory<OpenAPI>
Interface for OpenAPI3RouterFactory. To add an handler, use
|