TestMace
0.0.1-beta.16
0.0.1-beta.16
  • Быстрый старт
  • Интерфейс
    • Меню
    • Обзор интерфейса
    • Черновики
    • Типы узлов
    • Горячие клавиши
  • Типы узлов
    • Project
    • Folder
    • RequestStep
    • Assertion
      • Compare
      • Contains
      • Script
      • XPath
    • Link
    • API description
      • ApiRootFolder
      • ApiFolder
      • ApiRoute
      • Импорт описания API
    • Broken
    • Script
  • Переменные
    • Пользовательские переменные
      • Статически определяемые переменные
      • Динамические переменные
    • Встроенные переменные
    • Переменные окружения
  • Работа с проектом
    • Cookie
    • Авторизация
  • Настройки
    • Proxy
  • Прочие возможности
    • Массовое редактирование таблиц
    • Импорт & Экспорт
      • Shared
      • cURL
      • Swagger
      • Postman
    • HTTP-заголовки по умолчанию
Powered by GitBook
On this page

Was this helpful?

  1. Типы узлов
  2. API description

ApiRootFolder

PreviousAPI descriptionNextApiFolder

Last updated 5 years ago

Was this helpful?

ApiRootFolder - это корневой узел поддерева описания API. Он, по аналогии с узлом, является корневым элементом, и в пределах поддерева описания API может быть может быть только один элемент данного типа. В остальном повторяет функционал узла.

Создать данный узел можно одним из следующих способов

  • Из контекстного меню узла

  • Воспользовавшись импортом из форматов описания API

Файловое представление

ApiRootFolder узел представляет из себя папку с названием узла, внутри которой содержится файл index.yml, имеющий следующий формат:

{
  "type": "object",
  "properties": {
    "type": {
      "description": "Type of ApiRootFolder node",
      "const": "ApiRootFolder",
      "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#"
}
Project
ApiFolder
Project