InterfaceParam 接口参数

1. 结构声明

TS Declaration

class InterfaceParam extends BaseNode {
    name: string = '';
    description: string;
    typeAnnotation: TypeAnnotation;
    in: 'query' | 'path' | 'body' | 'header' | 'cookie';
    required: boolean;
    defaultValue: DefaultValue;
}

JSON Schema

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "typeAnnotation": {
            "$ref": "#/definitions/TypeAnnotation"
        },
        "in": {
            "type": "string",
            "enum": [
                "query",
                "path",
                "body",
                "header",
                "cookie"
            ]
        },
        "required": {
            "type": "boolean"
        },
        "defaultValue": {
            "$ref": "#/definitions/DefaultValue"
        }
    },
    "required": [
        "name",
        "description",
        "typeAnnotation",
        "in",
        "required",
        "defaultValue"
    ],
    "additionalProperties": false
}