Interface OpenAPIRoute

public interface OpenAPIRoute

  • Method Details

    • addHandler

      OpenAPIRoute addHandler(Handler<RoutingContext> handler)
      Adds a handler for this route which is executed after the security and validation handlers defined in the contract
      Parameters:
      handler - The handler to add
      Returns:
      the route

    • getHandlers

      List<Handler<RoutingContext>> getHandlers()
      Returns:
      handlers of this route

    • addFailureHandler

      OpenAPIRoute addFailureHandler(Handler<RoutingContext> handler)
      Adds a failure handler for this route
      Parameters:
      handler - The failure handler to add
      Returns:
      the route

    • getFailureHandlers

      List<Handler<RoutingContext>> getFailureHandlers()
      Returns:
      failure handlers of this route

    • getOperation

      Operation getOperation()
      Returns:
      the related operation of this route

    • doValidation

      boolean doValidation()
      Returns:
      true if validation based on the OpenAPI contract is active for this route. By default, it is active.

    • setDoValidation

      OpenAPIRoute setDoValidation(boolean doValidation)
      Sets the validation flag for incoming requests.
      Parameters:
      doValidation - The validation flag.
      Returns:
      the route

    • doSecurity

      boolean doSecurity()
      Returns:
      true if security checks based on the OpenAPI contract are active for this route. By default, it is active.

    • setDoSecurity

      OpenAPIRoute setDoSecurity(boolean doSecurity)
      Sets the security flag for incoming requests.
      Parameters:
      doSecurity - The security flag.
      Returns:
      the route