Перейти к основному содержимому

Редакторы

В Реестре API есть 2 редактора: код-редактор и low-редактор. Вы можете переключаться между редакторами, поскольку они редактируют одну и ту же спецификацию.

Код-редактор

Код-редактор — это текстовый редактор, который поддерживает работу с API-спецификациями в форматах JSON, YAML или XML.

В код-редактор встроена проверка спецификаций на наличие ошибок. Проверка минимизирует количество ошибок в процессе интеграции и обмена данными. Подробные про проверки в разделе «Валидация».

Горячие клавиши

В Code-редакторе можно использовать следующие комбинации:

  • Замена текста — Ctrl + H
  • Форматирование JSON-кода (удаление лишних пробелов и табуляций) — Ctrl + Q
  • Поиск по коду — Ctrl + F
  • Свернуть все строки (для удобного просмотра структуры) — Ctrl + K + 0
  • Развернуть все строки — Ctrl + K + J
  • Отменить последнее изменение — Ctrl + Z
  • Вернуть отмененное изменение — Ctrl + Y

Low-редактор

Low-редактор — это редактор для создания спецификаций API через UI. Вместо ручного написания кода или работы с текстовыми файлами, вы можете заполнит заранее подготовленные поля: описание, параметры, заголовки, схемы ответа и другие. Low-редактор автоматически сформирует спецификацию в нужном формате (например, OpenAPI).