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": {
        "composedBy": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "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"
    ],
    "additionalProperties": false
}

2. 节点示例

(1) 示例

AST 如下：

JSON

{
    "concept": "InterfaceParam",
    "name": "phone",
    "description": "",
    "typeAnnotation": {
        "concept": "TypeAnnotation",
        "typeKind": "primitive",
        "typeNamespace": "nasl.core",
        "typeName": "Long",
        "inferred": false,
        "ruleMap": {}
    },
    "in": "query",
    "required": true
}

YAML

concept: InterfaceParam
name: phone
description: ""
typeAnnotation:
  concept: TypeAnnotation
  typeKind: primitive
  typeNamespace: nasl.core
  typeName: Long
  inferred: false
  ruleMap: {}
in: query
required: true

对应的代码如下：

文本化 NASL

@(
    description = "",
    in = "query",
)
phone: Integer