TestMace
Search…
ApiFolder
An ApiFolder is identical to a Follder node and is used to group nodes of another types (ApiRoute in this case).
There are two ways to create an ApiFolder node:
    Adding it from the ApiRootFolder node context menu;
    Using import from API description format.
This is how an ApiFolder node looks like in the project tree:
An ApiFolder node in the project tree
An ApiFolder node has the following context menu:
The ApiFolder context menu
    Add node. Click on it to add a child node. You can choose a node type in the submenu.
    Rename. Change the node name.
    Duplicate. Make a copy of the node. The new node will be named NodeName [Copy [number]].
    Remove node. Use it to delete the node.
    Show in explorer. Open the folder with the node in the file manager.
‌The ApiFolder node tab has the following interface:
The ApiFolder node tab interface
In the screenshot you can see the following parts of the tab:

File Representation

An ApiFolder node is a folder with the node name, containing the index.yml file with the following format:
1
{
2
"type": "object",
3
"properties": {
4
"type": {
5
"description": "Type of ApiFolder node",
6
"const": "ApiFolder",
7
"type": "string"
8
},
9
"children": {
10
"description": "List of children names",
11
"type": "array",
12
"items": {
13
"type": "string"
14
},
15
"default": []
16
},
17
"variables": {
18
"$ref": "#/definitions/NodeVariables",
19
"description": "Node variables dictionary"
20
},
21
"name": {
22
"description": "Node name",
23
"type": "string"
24
}
25
},
26
"required": [
27
"children",
28
"name",
29
"type",
30
"variables"
31
],
32
"definitions": {
33
"NodeVariables": {
34
"type": "object",
35
"additionalProperties": {
36
"type": "string"
37
}
38
}
39
},
40
"$schema": "http://json-schema.org/draft-07/schema#"
41
}
Copied!
Last modified 2yr ago
Copy link