Конструктор JSON

Конструктор в POLYHUB — это визуальный инструмент в виде форм, который позволяет создавать JSON  для метаданных по схеме без ручного прописывания ключей и их значений.
После заполнения данных в конструкторе на выходе получается готовый JSON-объект.

JSON-объект:
Это структурированные данные, записанные в виде пар “ключ — значение”

JSON-схема:
Это описание правил, по которым должен быть устроен JSON. Она задаёт:

  • какие поля должны быть;
  • какие у них типы (строка, число, список и т.д.);
  • какие поля обязательны;
  • как связаны вложенные объекты.

Дополнительно в системе определяются правила, которые обрабатываются конструктором для их отображения и обработки системой, полученного объекта.

Режимы конструктора

В системе предусмотрено 2 режима конструирования:

Простой

  • Визуальный интерфейс с возможностью перетаскивания элементов (drag-and-drop)
  • Организован по принципу "мастера", который для каждого элемента предлагает релевантные атрибуты и значения по схеме
  • Можно построить JSON с нуля, последовательно заполняя карточки из палитры
  • Предоставляет выбор доступных пользователю объектов системы в качестве элементов, в случае возможности их использования
  • Предоставляет возможность пользователю построить JSON  в текстовом формате с валидацией с специальном редакторе

Предупреждение:  Режим конструктора “Простой” остаётся доступным, но будет отключен в будущем. Рекомендуем перейти на режим Мастер, чтобы избежать сбоев.

Мастер

  • Визуальный интерфейс в виде карточек объектов, построенных по схеме
  • Все доступные атрибуты отображаются в карточке объекта в виде наименования атрибута и поля для ввода значения
  • Вложенные объекты, такие как массивы и объекты, открываются как отдельные карточки, где можно заполнять их поля
  • Массивы отображаются как списки, в которые можно добавлять и удалять элементы
  • Поля подстраиваются под тип данных схемы (строка, число и т.д.) и могут содержать выпадающие списки, подсказки и автозаполнение.
  • Подходит для быстрого ввода данных по уже заданной структуре, без необходимости собирать JSON вручную

В текущем режиме доступны следующий функционал просмотра данных:

  • Модель – инструмент для конструирования
  • Данные – позволяет просмотр и редактирование JSON в обогащенном виде
  • Схема – позволяет просмотр JSON схемы, по которой валидируется JSON
  • Превью – позволяет просмотреть построенный в конструкторе JSON

Редактирование в конструкторе.

  • Для добавления значения в поле атрибута нажмите на кнопку + рядом со значением атрибута, также доступно добавление значения по двойному клику на поле значения.
                                       

  • Для редактирования значения откройте поле на редактирование двойным кликом на поле ввода

  • Обязательные поля  поля помечены звездочкой перед началом наименование * и по умолчанию открыты.

  • Для перехода в поля типа списков или объектов нажмите на кнопку > или используйте двойной клик по полю

  • Для добавления элементов списка нажмите на кнопку + в шапке карточки объекта.

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

Выбор схемы для конструирования.

Доступен только при описании документа!

При выборе режима конструирования доступен выбор режима Мастера с указанием схемы конструирования. Текущий режим позволяет использовать собственную схему для конструирования, где представления используемые в конструкторе будут совпадать с пользовательской схемой, а валидация вестить по системной схеме, которая принадлежиит объекту.

Для создания собсвенной схемой воспользуйтесь подсказками в разделе Дополнения к схеме