fastman/lib/openapi-parser/models/3.0/header.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 {OasHeader} from "../common/header.model";
import {Oas30Schema} from "./schema.model";
import {Oas30Example, Oas30ExampleItems} from "./example.model";
import {IOas30NodeVisitor, IOasNodeVisitor} from "../../visitors/visitor.iface";
import {Oas30ParameterContent} from "./parameter.model";
import {Oas30MediaType} from "./media-type.model";

/**
 * Models an OAS 3.0 Header object.  Example:
 *
 * {
 *   "description": "The number of allowed requests in the current period",
 *   "required": true,
 *   "schema": {
 *     "type": "string"
 *   }
 * }
 */
export class Oas30Header extends OasHeader {

    public $ref: string;
    public required: boolean;
    public deprecated: boolean;
    public allowEmptyValue: boolean;
    public style: string;
    public explode: boolean;
    public allowReserved: boolean;
    public schema: Oas30Schema;
    public example: any;
    public examples: Oas30ExampleItems;
    public content: Oas30ParameterContent = new Oas30ParameterContent();

    /**
     * Constructor.
     * @param headerName
     */
    constructor(headerName: string) {
        super(headerName);
    }

    /**
     * Creates a child items model.
     * @return {Oas30Schema}
     */
    public createSchema(): Oas30Schema {
        let rval: Oas30Schema = new Oas30Schema();
        rval._ownerDocument = this._ownerDocument;
        rval._parent = this;
        return rval;
    }

    /**
     * Creates a child Example model.
     * @return {Oas30Example}
     */
    public createExample(name: string): Oas30Example {
        let rval: Oas30Example = new Oas30Example(name);
        rval._ownerDocument = this._ownerDocument;
        rval._parent = this;
        return rval;
    }

    /**
     * Adds the Example to the map of examples.
     * @param example
     */
    public addExample(example: Oas30Example): void {
        if (!this.examples) {
            this.examples = new Oas30ExampleItems();
        }
        this.examples[example.name()] = example;
    }

    /**
     * Removes an Example and returns it.
     * @param name
     * @return {Oas30Example}
     */
    public removeExample(name: string): Oas30Example {
        let rval: Oas30Example = null;
        if (this.examples) {
            rval = this.examples[name];
            delete this.examples[name];
        }
        return rval;
    }

    /**
     * Gets a single example by name.
     * @param name
     * @return {any}
     */
    public getExample(name: string): Oas30Example {
        if (this.examples) {
            return this.examples[name];
        } else {
            return null;
        }
    }

    /**
     * Gets all examples.
     * @return {Oas30Example[]}
     */
    public getExamples(): Oas30Example[] {
        let examples: Oas30Example[] = [];
        if (this.examples) {
            for (let exampleName in this.examples) {
                let example: Oas30Example = this.examples[exampleName];
                examples.push(example);
            }
        }
        return examples;
    }

    /**
     * Creates a media type.
     * @param name
     * @return {Oas30MediaType}
     */
    public createMediaType(name: string): Oas30MediaType {
        let rval: Oas30MediaType = new Oas30MediaType(name);
        rval._ownerDocument = this._ownerDocument;
        rval._parent = this;
        return rval;
    }

    /**
     * Adds a media type.
     * @param name
     * @param mediaType
     */
    public addMediaType(name: string, mediaType: Oas30MediaType): void {
        this.content[name] = mediaType;
    }

    /**
     * Gets a single media type by name.
     * @param name
     * @return {Oas30MediaType}
     */
    public getMediaType(name: string): Oas30MediaType {
        return this.content[name];
    }

    /**
     * Removes a single media type and returns it.  This may return null or undefined if none found.
     * @param name
     * @return {Oas30MediaType}
     */
    public removeMediaType(name: string): Oas30MediaType {
        let rval: Oas30MediaType = this.content[name];
        if (rval) {
            delete this.content[name];
        }
        return rval;
    }

    /**
     * Gets a list of all media types.
     * @return {Oas30MediaType[]}
     */
    public getMediaTypes(): Oas30MediaType[] {
        let rval: Oas30MediaType[] = [];
        for (let name in this.content) {
            rval.push(this.content[name]);
        }
        return rval;
    }

}


/**
 * Models a header definition found in the components section of an OAS document.
 */
export class Oas30HeaderDefinition extends Oas30Header {

    /**
     * Constructor.
     * @param name
     */
    constructor(name: string) {
        super(name);
    }

    /**
     * Accepts the given OAS node visitor and calls the appropriate method on it to visit this node.
     * @param visitor
     */
    public accept(visitor: IOasNodeVisitor): void {
        let viz: IOas30NodeVisitor = <IOas30NodeVisitor> visitor;
        viz.visitHeaderDefinition(this);
    }

    /**
     * Gets the schema's property name.
     * @return {string}
     */
    public name(): string {
        return this.headerName();
    }

}