fastman/lib/openapi-parser/models/node.model.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 {OasDocument} from "./document.model";
import {IOasNodeVisitor} from "../visitors/visitor.iface";
import {OasNodePath} from "./node-path";

var __modelIdCounter = 0;


/**
 * Base class for all OAS nodes.  Contains common fields and methods across all
 * nodes of all versions of the OpenAPI Specification.
 */
export abstract class OasNode {

    public _ownerDocument: OasDocument;
    public _parent: OasNode;
    public _modelId: number = __modelIdCounter++;
    public _attributes: OasNodeAttributes = new OasNodeAttributes();
    public _validationProblems: any = {}; // Really a map of string(errorCode)->OasValidationProblem

    /**
     * Gets the owner document.
     * @return {OasDocument}
     */
    public ownerDocument(): OasDocument {
        return this._ownerDocument;
    }

    /**
     * Gets the parent.
     * @return {OasNode}
     */
    public parent(): OasNode {
        return this._parent;
    }

    /**
     * Gets the model's unique ID.
     * @return {number}
     */
    public modelId(): number {
        return this._modelId;
    }

    /**
     * Accept the given visitor (call back the appropriate visit() method).
     * @param visitor
     */
    public abstract accept(visitor: IOasNodeVisitor): void;

    /**
     * Gets or sets a node attribute.  When setting the attribute, the previous value
     * will be returned. Otherwise the current value is returned.
     * @param name
     * @param value
     * @return {any}
     */
    public n_attribute(name: string, value?: any): any {
        if (value === undefined) {
            return this._attributes[name];
        } else {
            let pvalue: any = this._attributes[name];
            this._attributes[name] = value;
            return pvalue;
        }
    }

    public validationProblems(): OasValidationProblem[] {
        let problems: OasValidationProblem[] = [];
        for (let problem of this._validationProblems) {
            problems.push(problem);
        }
        return problems;
    }

    public validationProblemCodes(): string[] {
        let codes: string[] = [];
        for (let code in this._validationProblems) {
            codes.push(code);
        }
        return codes;
    }

    public validationProblem(code: string): OasValidationProblem {
        return this._validationProblems[code];
    }

    public addValidationProblem(errorCode: string, nodePath: OasNodePath, message: string): OasValidationProblem {
        let problem: OasValidationProblem = new OasValidationProblem(errorCode, nodePath, message);
        problem._ownerDocument = this._ownerDocument;
        problem._parent = this;
        this._validationProblems[errorCode] = problem;
        return problem;
    }

    public clearValidationProblems(): void {
        this._validationProblems = {};
    }
}

/**
 * Represents a single validation error.
 */
export class OasValidationProblem extends OasNode {

    public errorCode: string;
    public nodePath: OasNodePath;
    public message: string;

    /**
     * Constructor.
     * @param {string} errorCode
     * @param {OasNodePath} nodePath
     * @param {string} message
     */
    constructor(errorCode: string, nodePath: OasNodePath, message: string) {
        super();
        this.errorCode = errorCode;
        this.nodePath = nodePath;
        this.message = message;
    }

    public accept(visitor: IOasNodeVisitor): void {
        visitor.visitValidationProblem(this);
    }

}


export class OasNodeAttributes {

    [key: string]: any;

}