ApiFolder

ApiFolder узел, по аналогии с Folder узлом, служит для группировки других типов узлов (в данном случае ApiRoute узлов).

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

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

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

В дереве проекта ApiFolder узел имеет следующий вид:

Контекстное меню данного узла выглядит следующим образом:

  • Add node. Добавление узла-потомка. В подменю можно выбрать тип узла.

  • Rename. Переименовать узел.

  • Duplicate. Сделать копию узла. Новый узел будет иметь название NodeName [Copy [number]].

  • Remove node. Удалить узел.

  • Show in explorer. Открыть папку с узлом в файловом менеджере.

Интерфейс вкладки данного узла выглядит следующим образом:

На данном скрине отмечены следующие области

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

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

{
  "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#"
}

Last updated