io.vertx.ext.web.openapi.router.OpenAPIRoute Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-web-openapi-router Show documentation

There is a newer version: 5.0.0.CR3

Show newest version

/*
 * Copyright (c) 2023, SAP SE
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 *
 */

package io.vertx.ext.web.openapi.router;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.ext.web.RoutingContext;
import io.vertx.openapi.contract.Operation;

import java.util.List;

@VertxGen
public interface OpenAPIRoute {

  /**
   * Adds a handler for this route which is executed after the security and validation handlers defined in the contract
   *
   * @param handler The handler to add
   * @return the route
   */
  @Fluent
  OpenAPIRoute addHandler(Handler handler);

  /**
   * @return handlers of this route
   */
  @GenIgnore
  List> getHandlers();

  /**
   * Adds a failure handler for this route
   *
   * @param handler The failure handler to add
   * @return the route
   */
  @Fluent
  OpenAPIRoute addFailureHandler(Handler handler);

  /**
   * @return failure handlers of this route
   */
  @GenIgnore
  List> getFailureHandlers();

  /**
   * @return the related operation of this route
   */
  Operation getOperation();

  /**
   * @return true if validation based on the OpenAPI contract is active for this route. By default, it is active.
   */
  boolean doValidation();

  /**
   * Sets the validation flag for incoming requests.
   *
   * @param doValidation The validation flag.
   * @return the route
   */
  OpenAPIRoute setDoValidation(boolean doValidation);
}