TestMace
0.0.1-beta.7
0.0.1-beta.7
  • Getting Started
  • Interface
    • The Menu
    • Interface Overview
    • Scratches
    • Node Types
    • Keyboard Shortcuts
  • Node Types
    • Project
    • Folder
    • RequestStep
    • Assertion
      • Compare
      • Contains
      • Script
      • XPath
    • Link
    • API description
      • ApiRootFolder
      • ApiFolder
      • ApiRoute
      • API Description Import
    • Broken
    • Script
  • Variables
    • User-Defined Variables
      • Static Variables
      • Dynamic Variables
    • Default Variables
    • Environment Variables
  • Working with the project
    • Cookie
    • Authorization
  • Settings
    • Proxy
  • Other features
    • Bulk Edit
    • Import & Export
      • Shared
      • cURL
      • Swagger
      • Postman
    • Default HTTP headers
Powered by GitBook
On this page

Was this helpful?

  1. Node Types
  2. API description

ApiFolder

PreviousApiRootFolderNextApiRoute

Last updated 5 years ago

Was this helpful?

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 node context menu;

  • Using import from API description format.

This is how an ApiFolder node looks like in the project tree:

An ApiFolder node has the following 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:

In the screenshot you can see the following parts of the tab:

  • Child nodes list.

File Representation

An ApiFolder node is a folder with the node name, containing the index.yml file with the following format:

{
  "type": "object",
  "properties": {
    "type": {
      "description": "Type of ApiFolder node",
      "const": "ApiFolder",
      "type": "string"
    },
    "children": {
      "description": "List of children names",
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": []
    },
    "variables": {
      "$ref": "#/definitions/NodeVariables",
      "description": "Node variables dictionary"
    },
    "name": {
      "description": "Node name",
      "type": "string"
    }
  },
  "required": [
    "children",
    "name",
    "type",
    "variables"
  ],
  "definitions": {
    "NodeVariables": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The managing dialog;

user-defined variables
ApiRootFolder
An ApiFolder node in the project tree
The ApiFolder context menu
The ApiFolder node tab interface