com.networknt.openapi.ApiNormalisedPath Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-parser Show documentation
A light-weight, fast OpenAPI 3.0 parser and validator
The newest version!
/*
 * Copyright (c) 2016 Network New Technologies Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.networknt.openapi;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.List;

import static java.util.Objects.requireNonNull;

/**
 * This utility normalize the RESTful API path so that they can be
 * handled identically.
 *
 * @author Steve Hu
 */
public class ApiNormalisedPath implements NormalisedPath {
    Logger logger = LoggerFactory.getLogger(ApiNormalisedPath.class);
    private final List pathParts;
    private final String original;
    private final String normalised;

    /**
     * Construct normalized path
     * @param path original path
     * @param basePath the path you want to overwrite
     *                 - put null will use the base path parsed from {@link OpenApiHelper}
     *                 - put "" empty String will not trigger any overwrites
     *                 - put regex will replace the first basePath with empty String
     */
    public ApiNormalisedPath(final String path, final String basePath) {
        if (logger.isDebugEnabled()) logger.debug("path = {}, base path is set to: {}", path, basePath);
        this.original = requireNonNull(path, "A path is required");
        this.normalised = normalise(path, basePath);
        if (logger.isDebugEnabled()) logger.debug("normalised = " + this.normalised);
        this.pathParts = List.of(normalised.split("/"));
    }

    @Override
    public List parts() {
        return pathParts;
    }

    @Override
    public String part(int index) {
        return pathParts.get(index);
    }

    @Override
    public boolean isParam(int index) {
        final String part = part(index);
        return part.startsWith("{") && part.endsWith("}");
    }

    @Override
    public String paramName(int index) {
        if (!isParam(index)) {
            return null;
        }
        final String part = part(index);
        return part.substring(1, part.length() - 1);
    }

    @Override
    public String original() {
        return original;
    }

    @Override
    public String normalised() {
        return normalised;
    }

    // case basePath == null, use OpenApiHelper.basePath
    // case basePath != null, remove the basePath
    private String normalise(String requestPath, String basePath) {
        requestPath = requestPath.replaceFirst(basePath, "");

        if (!requestPath.startsWith("/")) {
            return "/" + requestPath;
        }
        return requestPath;
    }
}