Валидатор OpenApi-схем на 1С

26.11.24

Интеграция - WEB-интеграция

В современном мире OpenAPI (Swagger) является стандартом для описания RESTful API. Данная подсистема позволит вам проверять входящие и исходящие пакеты данных на соответствие контракту OpenAPI 3.0.x.

Скачать файл

ВНИМАНИЕ: Файлы из Базы знаний - это исходный код разработки. Это примеры решения задач, шаблоны, заготовки, "строительные материалы" для учетной системы. Файлы ориентированы на специалистов 1С, которые могут разобраться в коде и оптимизировать программу для запуска в базе данных. Гарантии работоспособности нет. Возврата нет. Технической поддержки нет.

Наименование По подписке [?] Купить один файл
Валидатор OpenApi-схем на 1с:
.cf 97,97Kb ver:0.0.3.1
5
5 Скачать (2 SM) Купить за 2 150 руб.

Зачем это нужно?

Каждый раз когда мне приходится выполнять какую-то интеграцию, я слышу про 1С одно и то же. У систем 1С или нет контрактов совсем, или они не соблюдаются чуть более чем полностью.

Регулярно вижу запросы от коллег, вроде: "Сформировал тестовый json! Прошу проверить на корректность"

Данная подсистема призвана дать возможность выявлять проблемы в ваших интеграциях на более ранней стадии.

Если сформированный вами пакет - не проходит валидацию, то нет смысла отправлять его в систему-приемник.

Или же, если принятое сообщение не содержит обязательных полей, зачем нам делать что-то дальше? Мы можем сразу ответить, что не будем его обрабатывать, и вернуть ошибку.


Как пользоваться подсистемой

 

Если вкратце, то надо вызвать ровно одну функцию:

МассивОшибок = ВалидаторПакетов.Валидировать(МодельДанных, ИмяСхемыМодели, СпецификацияOpenApi);

МодельДанных - Это собственно наши данные. Можно передавать Структуру, соответствие, Массив или же примитивы(Булево, строку или число)
ИмяСхемыМодели - Имя схемы в спецификации OpenApi

СпецификацияOpenApi - Ну и наконец, спецификация - Это строка в формате JSON. Ваша openApi спецификация, которую вы скачали по ссылке, или же сохранили куда-нибудь в макет.

Все, на выходе у вас будет структура содержащая результат валидации, массив ошибок и массив предупреждений. Если ошибок нет, то валидация прошла успешно!

В приложенной конфигурации есть Демо-обработка, в которой можно вставлять свои данные и валидировать их.

 

 

Текущие возможности

  • Валидация строк
    • Максимальная и минимальная длина строк
    • соответствие форматам и паттернам
    • Валидация значений, которые сериализуются в строки(т.е. с форматом uuid можно валидировать уникальныйИдентификатор, а с date - дату)
  • Валидация чисел
    • Проверка целых чисел
    • Проверка на больше-меньше
    • Проверка на кратность
  • Валидация массивов
    • Проверка уникальных значений
    • Проверка на количество элементов
    • Проверки всех элементов на соответствие вложенным схемам
  • Проверки объектов
    • Проверка на количество свойств
    • Обработка флага "additionalProperties" валидация по вложенной схеме так же работает
    • Обработка Обязательных элементов
  • Базовые возможности
    • Разрешение $ref
    • Обработка nullable
    • Работа с конструкциями allOf, anyOf и oneOf, not
    • Обработка дискриминатора
    • Обработка depricated. (Не влияют на результат валидации, но позволяют обрабатывать предупреждения)

 

Чего пока нет

Нет фильтрации свойств на основании признаков readonly и writeonly

Нет поддержки xml


Требования к платформе

Для работы разбора форматов строк требуются регулярные выражения, потому требуется платформа 8.3.23+, но вы всегда можете просто убрать проверку форматов, если вдруг она вам не нужна. И тогда в целом почти любая платформа подойдет.

Тестировалось на 8.3.23, 8.3.24, 8.3.25


Благодарности

За основу была взята разработка Данная разработка

 

Где скачать?

Код разработки открыт и доступен на github

OpenApi Swagger валидация json интеграция schema

См. также

Сайты и интернет-магазины WEB-интеграция Системный администратор Программист Пользователь Платформа 1С v8.3 Конфигурации 1cv8 1С:Управление торговлей 11 Автомобили, автосервисы Россия Управленческий учет Платные (руб)

Интеграционный модуль обмена между конфигурацией Альфа Авто 5 и Альфа Авто 6 и порталом AUTOCRM. Данный модуль универсален. Позволяет работать с несколькими обменами AUTOCRM разных брендов в одной информационной базе в ручном и автоматическом режиме.

36000 руб.

03.08.2020    17878    19    22    

17

Сайты и интернет-магазины Интеграция WEB-интеграция Платформа 1С v8.3 Конфигурации 1cv8 Управленческий учет Платные (руб)

Интеграция 1С и Битрикс 24. Разработка имеет двухстороннюю синхронизацию 1С и Bitrix24 задачами. Решение позволяет создавать пользователя в 1С из Битрикс24 и наоборот. Данная разработка технически подходит под все основные конфигурации линейки продуктов 1С:Предприятие 8.3 (платформа начиная с 8.3.23). При приобретении предоставляется 1 месяц бесплатных обновлений разработки. Доступна демо-версия продукта с подключением Вашего Битрикс24

7200 руб.

04.05.2021    20002    13    17    

17

WEB-интеграция 8.3.8 Конфигурации 1cv8 Автомобили, автосервисы Беларусь Украина Россия Казахстан Управленческий учет Платные (руб)

Расширение предназначено для конфигурации "1С:Предприятие 8. Управление Автотранспортом. ПРОФ". Функционал модуля: 1. Заполнение регистров сведений по подсистеме "Мониторинг", а именно: события по мониторингу, координаты по мониторингу, пробег и расход по мониторингу, текущее местоположение ТС по мониторингу 2. Заполнение путевого листа: пробег по мониторингу, время выезда/заезда, табличная часть ГСМ, места стоянок по геозонам. 3. Отчеты по данным загруженным в регистры сведений. 4. Предусмотрена автоматическая загрузка данных в фоновом режиме (условия работы данной загрузке читайте в описании товара) Модуль работает без включенной константы по настройкам мониторинга. Модуль формы предоставляется с открытым кодом, общий модуль защищен. Любой заинтересованный пользователь, имеет возможность скачать демо-версию расширения.

22656 руб.

25.05.2021    14485    42    8    

18

WEB-интеграция Программист Руководитель проекта Платформа 1С v8.3 Конфигурации 1cv8 1С:Франчайзи, автоматизация бизнеса Платные (руб)

Расширение значительно упрощает написание API на 1С. Веб программисты получают простой и понятный доступ к 1С. Описание API создаётся автоматически и представляется в виде удобном как для человека, так и для программной обработки.

24000 руб.

27.09.2024    1486    1    0    

3
Оставьте свое сообщение