Справочник моделей

Модель — именованное описание структуры JSON-объекта в формате JSON Schema (OpenAPI). Справочник хранит модели в одном месте, ведёт историю их изменений и позволяет вернуть любую сохранённую версию.

Как открыть

Меню Плагины → Справочник моделей. На странице показан список моделей с описанием. Поле поиска над списком фильтрует модели по наименованию.

Список моделей

Действия в строке модели:

  • значок карандаша открывает модель в редакторе;

  • значок корзины удаляет модель после подтверждения. Вместе с моделью удаляется вся её история изменений.

Новая модель создаётся кнопкой Добавить элемент над списком.

Редактор модели

Редактор модели в режиме конструктора
Поле Описание

Наименование

Обязательное, не длиннее 100 символов. Должно быть уникальным в справочнике.

Описание

Необязательный комментарий: для чего модель и где используется.

Структура модели задаётся в одном из двух режимов, переключатель Конструктор / JSON.

Конструктор

Корень модели — объект (object). Для каждого поля указываются:

  • Тип — string, number, integer, boolean, object или array;

  • Поле — имя свойства;

  • переключатель Обязательный;

  • описание, значение по умолчанию и признак Nullable — в раскрывающейся части поля;

  • ограничения по типу: формат, допустимые значения, длина и регулярное выражение для строк, минимум, максимум и кратность для чисел, число и уникальность элементов для массивов.

Поля вложенного объекта добавляются кнопкой Добавить поле внутри него, порядок меняется перетаскиванием за маркер слева. Блок Preview внизу показывает получившуюся схему в виде дерева (Schema) или JSON.

JSON

Схему можно ввести или вставить текстом.

Редактор модели в режиме JSON
Действие Что делает

Форматировать

Расставляет отступы.

Проверить

Проверяет, что текст является корректным JSON и корректной схемой. Результат показывается во всплывающем сообщении.

Экспорт

Сохраняет схему в файл schema-<наименование>.json.

Импорт

Загружает схему из JSON-файла и заменяет текст в редакторе.

Перед сохранением схема приводится к единому виду. Если схема не является объектом, сохранение отклоняется с сообщением, в каком месте ошибка.

Сохранение

Кнопка Сохранить записывает модель, Отмена закрывает редактор без сохранения. Если ничего не изменилось, повторное сохранение не создаёт новую версию.

История изменений

У сохранённой модели в редакторе есть блок История изменений. Каждая запись показывает время, автора и что изменилось: наименование, описание или схема. Текущая версия отмечена меткой текущая.

История изменений модели

  • Значок глаза показывает схему этой версии.

  • Значок стрелки возвращает версию в редактор. Модель изменится только после нажатия Сохранить; при этом в истории появится новая запись, а прежние версии сохранятся.

Права

Права задаются в карточке пользователя или набора прав: Права → Плагин справочник объектов.

Право Что разрешает

Просмотр справочника объектов

Открыть страницу справочника.

Поиск

Загрузить список моделей и искать по наименованию.

Создание / Сохранение

Создать модель и сохранить изменения.

История изменений

Просмотреть историю модели.

Удаление

Удалить модель.