JSON

Последняя версия: 1.3.0

Дистрибутив: образ плагина JSON

Описание

Плагин JSON предназначен для загрузки и визуализации данных из JSON. Источник данных можно настроить в одном из четырёх режимов: загрузка файла, получение по URL, ввод JSON-текста вручную или чтение из файловой системы.

Форма создания источника данных построена на стандартном конструкторе Графини с динамическими полями. При проверке подключения плагин пытается прочитать и разобрать JSON из выбранного источника.

Настройка

Ниже приведены примеры формы создания источника данных JSON в интерфейсе Графини.

Базовая форма

Режим URL с проверкой TLS

Режим URL с дополнительными заголовками

Режим Ввод текста файла

Режим Файловая система

Поля источника данных

Название в UI	Код поля	Тип	Обязательность	Примечание
Источник данных	source	radio	обязательно	Выбирает режим получения JSON: Загрузка файла, URL, Ввод текста файла, Файловая система
Кодировка	encoding	select	обязательно	По умолчанию UTF-8; доступны UTF-8, UTF-16, Windows-1251, US-ASCII
Формат времени	timeFormat	text	необязательно	Используется для разбора временных значений; если поле не заполнено, применяется dd-MM-yyyy HH:mm:ss
Выберите файл до 768 Кб	content	file	обязательно в режиме Загрузка файла	Принимается JSON-файл размером до 768 Кб
Метод	method	select	обязательно в режиме URL	Доступны GET, POST, PUT
URL	url	text	обязательно в режиме URL	Должен быть указан в формате валидного URL
Пропустить проверку TLS	skipTls	radio	обязательно в режиме URL	Триггерное поле со значениями Проверять и Игнорировать
TLS-сертификат	tls	textarea	необязательно	Отображается при выборе Проверять
Добавить заголовки	hasHeaders	radio	обязательно в режиме URL	Триггерное поле со значениями Нет и Да
Заголовок	headers	array	обязательно при выборе Да	Контейнер для пользовательских HTTP-заголовков
Название	headers[].name	text	обязательно в блоке Заголовок	Имя HTTP-заголовка
Значение	headers[].value	text	необязательно в блоке Заголовок	Значение HTTP-заголовка
JSON-содержимое	data	textarea	обязательно для практического использования в режиме Ввод текста файла	Содержимое JSON, вставляемое вручную
Путь к файлу	path	text	обязательно для практического использования в режиме Файловая система	Путь к JSON-файлу, доступному контейнеру или серверу плагина

Динамические поля и зависимости

Главное триггерное поле формы: Источник данных.

1. Если выбрано Загрузка файла: отображается поле Выберите файл до 768 Кб.

2. Если выбрано URL: отображаются поля Метод, URL, Пропустить проверку TLS и Добавить заголовки.

3. Если в режиме URL в поле Пропустить проверку TLS выбрано Проверять: дополнительно отображается поле TLS-сертификат.

4. Если в режиме URL в поле Добавить заголовки выбрано Да: появляется блок Заголовок с возможностью добавить одну или несколько пар Название / Значение.

5. Если выбрано Ввод текста файла: отображается поле JSON-содержимое.

6. Если выбрано Файловая система: отображается поле Путь к файлу.

Поле Кодировка отображается во всех режимах. Поле Формат времени также доступно во всех режимах и влияет на разбор временных значений в данных.

Правила заполнения, важные для проверки подключения

• В одном источнике данных должен использоваться только один способ получения JSON.
• Для режима Загрузка файла необходимо выбрать JSON-файл размером до 768 Кб.
• Для режима URL обязательно заполнить Метод, URL и выбрать значение в поле Пропустить проверку TLS.
• Значение в поле URL должно быть корректным URL-адресом.
• Если выбрано Проверять, при работе с собственным сертификатом сервера следует заполнить поле TLS-сертификат.
• Если выбрано Да в поле Добавить заголовки, нужно добавить как минимум один элемент в блок Заголовок и заполнить поле Название.
• Для режима Ввод текста файла в поле JSON-содержимое должен быть передан корректный JSON.
• Для режима Файловая система в поле Путь к файлу должен быть указан путь к реально доступному JSON-файлу.
• Проверка подключения считается успешной, если плагин может прочитать и разобрать JSON из выбранного источника.

Порядок создания источника данных

1. Откройте раздел Источники данных и нажмите Добавление источника.
2. Заполните поле Источник данных понятным именем подключения.
3. В поле Тип выберите JSON.
4. В блоке Источник данных выберите один из режимов: Загрузка файла, URL, Ввод текста файла или Файловая система.
5. Заполните поля, относящиеся к выбранному режиму.
6. Выберите Кодировка.
7. При необходимости заполните Формат времени.
8. Нажмите Проверить соединение.
9. После успешной проверки нажмите Сохранить.

Пример заполнения

Вариант Загрузка файла

• Источник данных: Загрузка файла
• Выберите файл до 768 Кб: подготовленный JSON-файл
• Кодировка: UTF-8
• Формат времени: yyyy-MM-dd'T'HH:mm:ss, если в JSON используются такие временные метки

Вариант URL без дополнительных заголовков

• Источник данных: URL
• Метод: GET
• URL: https://example.local/api/data.json
• Пропустить проверку TLS: Проверять или Игнорировать в зависимости от схемы подключения
• TLS-сертификат: сертификат сервера, если требуется проверка собственного сертификата
• Добавить заголовки: Нет
• Кодировка: UTF-8

Вариант URL с авторизацией через заголовки

У плагина нет отдельного поля с выбором режима аутентификации. Для передачи токена, API-ключа или другого служебного заголовка используется блок Заголовок.

• Источник данных: URL
• Метод: GET, POST или PUT
• URL: адрес JSON-эндпоинта
• Пропустить проверку TLS: Проверять или Игнорировать
• Добавить заголовки: Да
• Название: Authorization
• Значение: Bearer <токен>

Вариант Ввод текста файла

• Источник данных: Ввод текста файла
• JSON-содержимое: корректный JSON-объект или JSON-массив
• Кодировка: UTF-8
• Формат времени: укажите при необходимости, если в JSON есть временные поля

Вариант Файловая система

• Источник данных: Файловая система
• Путь к файлу: file:///opt/grafinya/data/example.json
• Кодировка: UTF-8
• Формат времени: при необходимости

Для режима Файловая система важно указывать путь к файлу, который реально доступен процессу плагина. Если файл недоступен или JSON не удаётся разобрать, проверка подключения завершится ошибкой.