io.vertx.ext.web.openapi.router.impl.RouterBuilderImpl 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.impl;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.ext.web.Route;
import io.vertx.ext.web.Router;
import io.vertx.ext.web.RoutingContext;
import io.vertx.ext.web.handler.InputTrustHandler;
import io.vertx.ext.web.openapi.router.OpenAPIRoute;
import io.vertx.ext.web.openapi.router.RequestExtractor;
import io.vertx.ext.web.openapi.router.RouterBuilder;
import io.vertx.openapi.contract.OpenAPIContract;
import io.vertx.openapi.contract.Operation;
import io.vertx.openapi.contract.Path;
import io.vertx.openapi.validation.RequestValidator;
import io.vertx.openapi.validation.impl.RequestValidatorImpl;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

public class RouterBuilderImpl implements RouterBuilder {
  private static final String PATH_PARAM_PLACEHOLDER_REGEX = "\\{(.*?)}";

  // VisibleForTesting
  final List> rootHandlers = new ArrayList<>();
  private final Vertx vertx;
  private final OpenAPIContract contract;

  private final Map openAPIRoutes;

  private final RequestExtractor extractor;

  public RouterBuilderImpl(Vertx vertx, OpenAPIContract contract, RequestExtractor extractor) {
    this.vertx = vertx;
    this.contract = contract;
    this.extractor = extractor;
    this.openAPIRoutes =
      contract.operations().stream().collect(Collectors.toMap(Operation::getOperationId, OpenAPIRouteImpl::new));
  }

  /**
   * @param openAPIPath the path with placeholders in OpenAPI format
   * @return the path with placeholders in vertx-web format
   */
  // VisibleForTesting
  static String toVertxWebPath(String openAPIPath) {
    return openAPIPath.replaceAll(PATH_PARAM_PLACEHOLDER_REGEX, ":$1");
  }

  @Override
  public @Nullable OpenAPIRoute getRoute(String operationId) {
    return openAPIRoutes.get(operationId);
  }

  @Override
  public List getRoutes() {
    return new ArrayList<>(openAPIRoutes.values());
  }

  @Override
  @Fluent
  public RouterBuilder rootHandler(Handler rootHandler) {
    rootHandlers.add(rootHandler);
    return this;
  }

  @Override
  public Router createRouter() {
    Router router = Router.router(vertx);
    RequestValidator validator = new RequestValidatorImpl(vertx, contract);

    Route globalRoute = router.route();
    rootHandlers.forEach(globalRoute::handler);

    for (Path path : contract.getPaths()) {
      for (Operation operation : path.getOperations()) {
        Route route = router.route(operation.getHttpMethod(), toVertxWebPath(path.getName()));
        route.putMetadata(KEY_META_DATA_OPERATION, operation.getOperationId());

        OpenAPIRoute openAPIRoute = getRoute(operation.getOperationId());
        if (openAPIRoute.doValidation()) {

          InputTrustHandler validationHandler = rc -> extractor.extractValidatableRequest(rc, operation)
            .compose(validatableRequest -> validator.validate(validatableRequest, operation.getOperationId())).
            onSuccess(rp -> {
              rc.put(KEY_META_DATA_VALIDATED_REQUEST, rp);
              rc.next();
            }).onFailure(rc::fail);
          route.handler(validationHandler);
        }
        openAPIRoute.getHandlers().forEach(route::handler);
        openAPIRoute.getFailureHandlers().forEach(route::failureHandler);
      }
    }
    return router;
  }
}