BackendVariable 全局变量

结构声明

TS Declaration

interface BackendVariable {
    "concept": "BackendVariable", // 产品概念
    "name": string, // 全局变量名称
    "description": string, // 全局变量描述
    "typeAnnotation": TypeAnnotation, // 类型
    "defaultValue": string, // 默认值
    "scope": "request" | "applicaion", // 作用域
}

Java Class

class BackendVariableTreeNode {
    ConceptEnum concept; // 产品概念
    String name; // 全局变量名称
    String description; // 全局变量描述
    TypeAnnotationTreeNode typeAnnotation; // 类型
    String defaultValue; // 默认值
    ScopeEnum scope; // 作用域
}

JSON Schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$ref": "#/definitions/BackendVariable",
    "definitions": {
        "BackendVariable": {
            "type": "object",
            "properties": {
                "concept": {
                    "type": "string",
                    "const": "BackendVariable"
                },
                "name": {
                    "type": "string"
                },
                "description": {
                    "type": "string"
                },
                "typeAnnotation": {
                    "$ref": "#/definitions/TypeAnnotation"
                },
                "defaultValue": {
                    "type": "string"
                },
                "scope": {
                    "type": "string",
                    "enum": [
                        "request",
                        "applicaion"
                    ]
                }
            },
            "required": [
                "concept",
                "name",
                "description",
                "typeAnnotation",
                "defaultValue",
                "scope"
            ],
            "additionalProperties": false
        }
    }
}

示例

简单示例

JSON

{
    "concept": "BackendVariable",
    "name": "param1",
    "description": "",
    "typeAnnotation": null,
    "defaultValue": null,
    "scope": "request"
}

YAML

concept: BackendVariable
name: param1
description: ""
typeAnnotation: null
defaultValue: null
scope: request