fastman/lib/openapi-parser/visitors/visitor.utils.ts

快速api测试及文档生成

/**
 * @license
 * Copyright 2017 Red Hat
 *
 * 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.
 */

import {OasNode} from "../models/node.model";
import {IOasNodeVisitor, IOas20NodeVisitor, IOas30NodeVisitor} from "./visitor.iface";
import {Oas20Traverser, Oas20ReverseTraverser, IOasTraverser, Oas30ReverseTraverser, Oas30Traverser} from "./traverser";
import {Oas20ModelToJSVisitor} from "./model2js.visitor";
import {OasNodePath} from "../models/node-path";
import {OasDocument} from "../models/document.model";

export enum OasTraverserDirection {
    up, down
}

/**
 * Some static convenience methods for visiting an OAS node/tree.
 */
export class OasVisitorUtil {

    /**
     * Convenience method for visiting a single node.
     * @param node
     * @param visitor
     */
    public static visitNode(node: OasNode, visitor: IOasNodeVisitor): void {
        node.accept(visitor);
    }

    /**
     * Convenience method for visiting an OAS tree.  This will traverse and visit
     * all nodes starting with the given one and traversing down.
     * @param node the node to traverse and visit
     * @param visitor the visitor to call for each node visited
     */
    public static visitTree(node: OasNode, visitor: IOasNodeVisitor, direction: OasTraverserDirection = OasTraverserDirection.down): void {
        if (node.ownerDocument().is2xDocument()) {
            let traverser: IOasTraverser;
            if (direction === OasTraverserDirection.up) {
                traverser = new Oas20ReverseTraverser(visitor as IOas20NodeVisitor);
            } else {
                traverser = new Oas20Traverser(visitor as IOas20NodeVisitor);
            }
            traverser.traverse(node);
        } else if (node.ownerDocument().is3xDocument()) {
            let traverser: IOasTraverser;
            if (direction === OasTraverserDirection.up) {
                traverser = new Oas30ReverseTraverser(visitor as IOas30NodeVisitor);
            } else {
                traverser = new Oas30Traverser(visitor as IOas30NodeVisitor);
            }
            traverser.traverse(node);
        } else {
            throw new Error("OAS version " + node.ownerDocument().getSpecVersion() + " not supported.");
        }
    }

    /**
     * Convenience method for visiting all Nodes in a node path, relative to a given document.
     * @param {OasNodePath} path
     * @param {IOasNodeVisitor} visitor
     * @param {OasDocument} document
     */
    public static visitPath(path: OasNodePath, visitor: IOasNodeVisitor, document: OasDocument): void {
        path.resolve(document, visitor);
    }

}