vertx / io.vertx.kotlin.ext.web.api.contract / RouterFactoryOptions

RouterFactoryOptions

fun RouterFactoryOptions(mountNotImplementedHandler: Boolean? = null, mountResponseContentTypeHandler: Boolean? = null, mountValidationFailureHandler: Boolean? = null, operationModelKey: String? = null, requireSecurityHandlers: Boolean? = null): RouterFactoryOptions

A function providing a DSL for building io.vertx.ext.web.api.contract.RouterFactoryOptions objects.

Parameters

mountNotImplementedHandler - Automatic mount handlers that return HTTP 501 status code for operations where you didn't specify an handler. You can change the "not implemented handler" with io.vertx.ext.web.api.contract.RouterFactory

mountResponseContentTypeHandler - If true, when required, the factory will mount a io.vertx.ext.web.handler.ResponseContentTypeHandler

mountValidationFailureHandler - Enable or disable validation failure handler. If you enable it during router creation a failure handler that manages ValidationException will be mounted. You can change the validation failure handler with with function io.vertx.ext.web.api.contract.RouterFactory. If failure is different from ValidationException, next failure handler will be called.

operationModelKey - When set, an additional handler will be created to expose the operation model in the routing context under the given key. When the key is null, the handler is not added.

requireSecurityHandlers - If true, when you call io.vertx.ext.web.api.contract.RouterFactory the factory will mount for every path the required security handlers and, if a security handler is not defined, it throws an io.vertx.ext.web.api.contract.RouterFactoryException