HTTP сервисы по OpenAPI спецификациям

21.07.20

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

+96 –

Начинаем путь разработки HTTP сервисов с создания спецификаций OpenAPI. Автодокументация сервисов формата Swagger UI без зависимостей. Настройка сервисов в режиме предприятия.

Файлы

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

Наименование	Скачано	Купить файл (только для физ. лиц)	По подписке PRO
HTTP сервисы по OpenAPI спецификациям: 0.2.4.15 .zip 765,72Kb 21	21	1 850 руб. Купить	1 SM Скачать
HTTP сервисы по OpenAPI спецификациям: сборка 0.2.4.3 .zip 700,76Kb ver:0.2.4.3 6	6	1 850 руб. Купить	1 SM Скачать
HTTP сервисы по OpenAPI спецификациям: демонстрационная база 0.2.4.3 .dt 1,16Mb 14	14	1 850 руб. Купить	1 SM Скачать
HTTP сервисы по OpenAPI спецификациям: сборка 0.1.4.19 .zip 693,18Kb ver:0.1.4.19 2	2	1 850 руб. Купить	1 SM Скачать
HTTP сервисы по OpenAPI спецификациям: демонстрационная база 0.1.4.19 .dt 871,64Kb 4	4	1 850 руб. Купить	1 SM Скачать

Зачем это надо

Убрать разрыв между написанием кода и подготовкой документации
Всегда соответствующие документации сервисы
Унифицированный контроль соответствия поступивших запросов спецификации
Возможность унифицированного контроля формируемых ответов спецификации
Онлайн документацию формата Swagger UI средствами самого 1С сервиса без внешних зависимостей
Разделение этапов разработки интерфейса и реализации функционала
Выделение конечного функционала по обработкам
Возможность назначения обработчиков конечных точек сервиса в режиме предприятия
Возможность создавать в конечных обработчиках "долгоживущие" объекты

Требования

1С Предприятие версии >= 8.3.9

Установка

Проект на Gitlab

Скачать последнюю стабильную версию
Установить расширения в порядке номеров
Для установленных расширений снять флаги "Безопасный режим" и "Защита от опасных действий"

Использование

Простейшая конфигурация HTTP сервиса в конфигурации/расширении (нового)

В общем случае требуется один ресурс с шаблоном /* и одной конечной точкой, обрабатывающей все http-методы

Обработчик входящего запроса состоит из единственного вызова

    Возврат оас_Сервис.Ответ(Запрос);

Разрабатываем спецификацию сервиса в формате OpenAPI v3.x, сохраняем в формате JSON

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

stoplight - показался наиболее функциональным и дружелюбным, есть бесплатный тариф
mermade - полностью бесплатный, но не такой удобный как stoplight

Настройка сервиса в обработке "ОАС. Управление сервисами"

(на скриншоте отмечены номера пунктов в интерфейсе)

Обработка Управление сервисами

Выбрать HTTP-сервис
Загрузить спецификацию в 1С
Получаем шаблон модуля обработки, вызываемой при получении запросов к выбранной точке
1. Создаем обработку в конфигурации или расширении
Копируем текст шаблона в модуль объекта созданной обработки, реализуем функционал
Выбираем созданную обработку как обработчик запросов конечной точки сервиса

Повторяем пункты 3-5 для каждой конечной точки.

Шаблон модуля обработки (4) содержит комментарии, содержащие информацию о спецификации конечной точки

Имена сервиса, конечной точки, HTTP метода
Параметры, их обязательность
Тип тела запроса, его обязательность, при наличии в спецификации схема содержания
Схема тела ответа по спецификации

Автоматически формируемая сервисом документация

Тема "Просмотр"

Тема Просмотр

Тема "Чтение"

Sweet Swagger: Генератор OpenApi спецификаций для 1С

Инструмент для генерации OpenApi (Swagger) спецификаций на основании файлов конфигураций 1С. Это консольное и десктопное приложение на языке Rust с полноценным редактором кода, содержащим автозамену и подсвечивание ошибок для быстрого и безошибочного написания документирующего комментария.

Открыть

Вступайте в нашу телеграмм-группу Инфостарт

OpenAPI Swagger RestAPI HTTP сервисы

+96 –

См. также

Веб-портал "Онлайн-заказ" для 1С

Оптовая торговля Розничная торговля WEB-интеграция 1С:Управление торговлей 10 1С:Управление производственным предприятием 1С:Управление нашей фирмой 1.6 1С:Управление торговлей 11 1С:Комплексная автоматизация 2.х 1С:Управление нашей фирмой 3.0 Платные (руб)

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

57600 руб.

26.11.2024 5052 4 3

Amocrm: интеграция с 1С

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

Модуль "Подсистема интеграции AmoCRM с 1С" позволяет обеспечить единое информационное пространство, в котором пользователи могут эффективно управлять клиентской базой, следить за статусами сделок и поддерживать актуальность данных как в AmoCRM, так и в 1С.

60000 руб.

07.05.2019 37751 73 45

Экспортер — автоматизация выгрузки данных из 1С в Spot2D

WEB-интеграция Программист Бизнес-аналитик 1С v8.3 1С:ERP Управление предприятием 2 1С:Бухгалтерия 3.0 1С:Управление торговлей 11 1С:Комплексная автоматизация 2.х 1С:Управление нашей фирмой 3.0 1С:Розница 3.0 Оптовая торговля, дистрибуция, логистика ИТ-компания Платные (руб)

Модуль "Экспортер" — это расширение для 1С, предназначенное для автоматизации процессов выгрузки данных. Оно позволяет эффективно извлекать, преобразовывать и передавать данные из систем 1С в интеграционную платформу Spot2D. Подсистема упрощает настройку, снижает количество ручных операций и обеспечивает удобный контроль данных.

14400 руб.

20.12.2024 2672 14 2

Интеграция 1С с OpenCart 2.x, 3x модуль обмена данными

WEB-интеграция Оптовая торговля Розничная торговля Программист Управляемые формы 1С:Розница 2 1С:Управление нашей фирмой 1.6 1С:Бухгалтерия 3.0 1С:Управление торговлей 11 Розничная и сетевая торговля (FMCG) Оптовая торговля, дистрибуция, логистика Управленческий учет Платные (руб)

Модуль интеграции 1С с OpenCart 2.x, 3x позволяет обмениваться данными между OpenCart (самая популярная бесплатная cms для интернет-магазинов) и 1С:Предприятие 8.

6800 руб.

17.11.2015 125974 424 143

239

Все службы доставки в Вашей 1С! Без изменения конфигурации! 1С:УТ, 1С:ERP, 1С:КА, 1С:УНФ

WEB-интеграция Рабочее место Оптовая торговля Розничная торговля Логистика, склад и ТМЦ Программист Пользователь 1С v8.3 1С:ERP Управление предприятием 2 1С:Управление торговлей 11 Россия Управленческий учет Платные (руб)

40+ служб доставки для 1С в одном модуле! Внешняя обработка, которая НЕ изменяет Вашу конфигурацию! Подписная модель на 1 год.

19200 руб.

22.03.2017 41261 22 51

Заполнение контрагента по ИНН или наименованию реквизитов по данным сайта ФНС в 1С: 8.3

Обмен с ГосИС WEB-интеграция Бухгалтер Пользователь 1С v8.3 Управляемые формы 1С:Комплексная автоматизация 1.х 1С:Бухгалтерия 2.0 1С:Управление торговлей 10 1С:Управление производственным предприятием 1С:Управление нашей фирмой 1.6 1С:Бухгалтерия государственного учреждения 1С:Документооборот 1С:ERP Управление предприятием 2 1С:Бухгалтерия 3.0 1С:Управление торговлей 11 1С:Комплексная автоматизация 2.х Платные (руб)

Обработка является альтернативой механизму, разработанному фирмой 1С и заполняющему реквизиты контрагента по ИНН или наименованию. Не требуется действующей подписки ИТС. Вызывается как внешняя дополнительная обработка, т.е. используется, непосредственно, из карточки контрагента. Заполнение по ИНН или наименованию реквизитов контрагента по данным сайта ФНС (egrul.nalog.ru) для БП 2.0, БП 3.0, БГУ 1.0, БГУ 2.0, УТ 10.3, УТ 11.x, КА 1.1, КА 2.x, УПП 1.x, ERP 2.x, УНФ 1.5, УНФ 1.6, УНФ 3.0, ДО 2.1

3000 руб.

28.04.2016 96437 109 218

359

Интеграция по API 1С с СДТ (Сервис Дистанционной Торговли) фулфилмент полного цикла

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

В расширении реализован механизм интеграции между системой поставщика и Личным кабинетом СДТ. Реализован обмен заказами и реализациями (накладными), предусмотрено отслеживание статусов документов. Расширение предназначено для 1С:УТ 11.4.

35856 руб.

27.11.2024 1253 1 0

Интеграция Vetmanager с 1С: автоматизация учета для ветеринарных клиник. Синхронизация документов, справочников и оплат через API

WEB-интеграция Программист 1С v8.3 Бухгалтерский учет 1С:Бухгалтерия 3.0 Бытовые услуги, сервис Платные (руб)

Внешняя обработка разработана для автоматизации передачи данных между сервисом Vetmanager с 1С: Бухгалтерия 3.0. Решение позволяет загружать документы и справочники из Ветменеджер в 1С:Бухгалтерию, сокращая время на ручной ввод данных и минимизируя ошибки.

12000 руб.

02.02.2021 19953 57 52

Комментарии

Подписаться на ответы Инфостарт бот

Свернуть все

1. cprit 916 29.06.20 19:59 Сейчас в теме

Спасибо. То чего давно не хватало
Если автор не против, включу в универсальные инструменты 1С https://github.com/cpr1c/tools_ui_1c. Лицензия в репозитории позволяет

2. shmalevoz 312 29.06.20 20:15 Сейчас в теме

(1) Конечно не простив, включайте. У вас кстати ссылка битая. Верна https://github.com/cpr1c/tools_ui_1c

3. cprit 916 29.06.20 20:16 Сейчас в теме

(2) Видимо из-за скобок было. Поправил комментарий

4. Xershi 1538 29.06.20 22:18 Сейчас в теме

Насколько я понял это сервис, который 1 раз опубликовал и дальше пилишь справочники в предприятии и сразу генерируется документация?
У самого была такая идея, но не было задач для реализации конечного варианта.
Единственное авторизация есть на уровне сервиса или пилится кодом?
Аналогично разделение прав?

5. shmalevoz 312 29.06.20 22:46 Сейчас в теме

(4) Это прослойка между входящим запросом и конечным функционалом расположенным в обработках. Может обслуживать произвольное количество сервисов конфигурации. Для каждого сервиса своя спецификация.
На входе нужны
1. HTTP сервис, достаточно одного ресурса сервиса с шаблоном /* и одной конечной точкой с обработкой любого http метода. Обработчик точки может содержать только Возврат оас_Сервис.Ответ(Запрос)
2. Спецификацию OpenAPI v3 в формате json. Делается визуальными редакторами/руками
В обработке управления загружаем спецификацию, получаем шаблоны модулей конечных обработок. Создаем обработки, копируем шаблоны для конечных точек, наполняем их смыслом. Назначаем вызовы созданных обработок для конечных точек сервиса.
Расширение выполняет контроль соответствия входящего запроса загруженной спецификации. Единая точка проверки. И далее по настройкам вызывает конечные обработки реализующие логику точек. Есть события ПередОбработкойЗапроса, ПослеОбработкиЗапроса, обработчики назначаемы. Плюс на основании спецификации формирует документацию в распространенном юзерфрендли формате. Конечную логику (авторизацию) не изменяет.
Справочники не использует, все хранится в ХранилищеСистемныхНастроек

6. Xershi 1538 30.06.20 10:37 Сейчас в теме

(5) я так понимаю сделано чтобы снизить совместимость решения?
Лучше тогда сделать 3 варианта, конфигурация до 8.3.6, хранилище до момент использования справочников 8.3.11 и использование справочников в расширении.
Для заметок сделал публикацию Эволюция расширения конфигурации. С 8.3.11 доступно создавать свои справочники, а сейчас типовые уже 8.3.12+.

7. shmalevoz 312 30.06.20 10:52 Сейчас в теме

(6) Не вижу смысла пилить справочники для хранения набора условно константных соответствий с текстовым содержанием. Тем паче это данные расширения. Для этих целей очень неплохо подходит ХранилищеНастроек, как раз они там и хранятся. А совместимость с 8.3.9 сложилось достаточно исторически, при разработке базовых зависимостей, не помню уже какой там метод использовался, надо тесты запускать на младших платформах.
Относительно решения в конфигурации, то расширение в конфигурацию конвертируется легко - в Configuration.xml расширения меняется узел <Properties> на узел из конфигурации и загружается из файлов. Получается готовая конфигурация. Работающим на старых релизах + полчаса работы с перекурами.

8. botokash 397 30.06.20 11:03 Сейчас в теме

(7) А как происходит миграция загруженных настроек работы сервиса в РИБ?

9. Xershi 1538 30.06.20 11:25 Сейчас в теме

(8) судя из ответов автора никак. РИБ же переносит только пользовательские данные. А "ХранилищеНастроек" это служебные.

10. shmalevoz 312 30.06.20 11:32 Сейчас в теме

(9) Да, на РИБ текущая реализация не рассчитана, понадобится модификация чтения/записи настроек. Надо будет в будущем сделать адаптер хранения настроек чтобы управлять этим делом.

11. Xershi 1538 30.06.20 11:33 Сейчас в теме

(10) перейдя на 1 и 3 вариант это не понадобится.

12. shmalevoz 312 30.06.20 11:36 Сейчас в теме

(11) Как раз использование адаптера позволит не менять расширение, а вызывать необходимую выбранную реализацию хранения.

14. Xershi 1538 30.06.20 11:39 Сейчас в теме

(12) в любом случае хранение через справочники надежнее. Если инфа в хранилище побьется или будет удалена не очень приятно будет)

18. shmalevoz 312 01.07.20 10:17 Сейчас в теме

(14) В свежей версии появился адаптер хранения настроек, можно использовать любую собственную реализацию хранилища

17. shmalevoz 312 01.07.20 10:16 Сейчас в теме

(8) Теперь можно хранить настройки где угодно - делаем обработку с интерфейсом как в оас_НастройкиХранилищеСистемныхНастроек, выбираем ее адаптером хранения настроек в ОМ. Управление адаптерами (вид ОАС. Хранение настроек) и управление по чтению/записи настроек передается на нее. А там уж где хоть справочник, хоть регистр сведений, что угодно

13. shmalevoz 312 30.06.20 11:37 Сейчас в теме

А там уж кто какую схему хранения использует это дело хозяйское =)

15. malikov_pro 1346 30.06.20 14:58 Сейчас в теме

в модуле опечатка, style по идее.

Буду рад если поделитесь опытом ведения проекта в git и его сборки.

16. shmalevoz 312 30.06.20 15:09 Сейчас в теме

(15) Спасибо за поправку =)

19. shmalevoz 312 01.07.20 10:21 Сейчас в теме

(15) Не вопрос, поделюсь. Только вопрос больно расплывчатый. В личку пожалуйста, кажется вопрос объемен и лучше там обменяться контактами

20. zavbak 10.03.21 04:45 Сейчас в теме

Добрый день!
Падает по ошибке.

Пользователи	= ом_Значение.СвойствоПолучить(Настройки, "Пользователи", Новый Соответствие());

// Т.К. в ЕРП существует модуль. Пользователи. И он переменную воспринимает как модуль и не может записать.


// Сохранение настроек. Раздельно по регионам использования
//
// Параметры: 
// 	Регион - Строка - Регион использования адаптеров
// 	Настройки - Структура - Сохраняемые настройки
//
Процедура Сохранить(Регион, Настройки) Экспорт
	
	#Если Сервер Тогда
		Если лг_Подсистема.АдминистрированиеДоступно() Тогда
			УстановитьПривилегированныйРежим(Истина);
			Коллекция	= ХранилищеСистемныхНастроек.Загрузить(ОбъектКлюч()
			, НастройкаКлюч()
			, 
			, ПользовательИмя());
			Коллекция		= ?(ом_Значение.СоответствиеЭто(Коллекция), Коллекция, Новый Соответствие());
			// Сами настройки храним фиксированными структурами
			Пользователи	= ом_Значение.СвойствоПолучить(Настройки, "Пользователи", Новый Соответствие());
			Если ом_Значение.СоответствиеЭто(Пользователи) Тогда
				Пользователи	= Новый ФиксированноеСоответствие(Пользователи);
			Иначе
				Если НЕ ом_Значение.ФиксированноеСоответствиеЭто(Пользователи) Тогда
					ВызватьИсключение лг_ПодсистемаТексты.МетодПараметрСтруктураОшибка();
				КонецЕсли;
			КонецЕсли;
			Хранение	= Новый Структура(Умолчание());
			ЗаполнитьЗначенияСвойств(Хранение, Настройки);
			Хранение.Вставить("Пользователи", Пользователи);
			Хранение	= Новый ФиксированнаяСтруктура(Хранение);
			Коллекция.Вставить(РегионИмя(Регион), Хранение);
			ХранилищеСистемныхНастроек.Сохранить(ОбъектКлюч()
			, НастройкаКлюч()
			, Коллекция
			, 
			, ПользовательИмя());
			ОбновитьПовторноИспользуемыеЗначения();
		Иначе
			ВызватьИсключение лг_ПодсистемаТексты.АдминистрированиеЗапрещено();
		КонецЕсли;
	#Иначе 
		ВызватьИсключение лг_ПодсистемаТексты.СредаВыполненияФункционалНедоступен();
	#КонецЕсли
	  
КонецПроцедуры // Сохранить

Показать

22. zavbak 17.09.21 04:39 Сейчас в теме

(20) Надо исправлять.

21. o.nikolaev 217 24.04.21 19:52 Сейчас в теме

Толково.

23. trigor 27 24.03.23 11:11 Сейчас в теме

HTTP сервисы по OpenAPI спецификациям: демонстрационная база 0.2.4.3
dt-шник содержит расширенния

24. trigor 27 24.03.23 12:52 Сейчас в теме

Неплохо было бы ещё клиента генерировать по OpenAPI спецификациям.
Автору спасибо за идею

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

E-mail:

Автор:

Валерий Крынин (shmalevoz)

Рейтинг: 312

Для получения уведомлений о новых публикациях автора подключите телеграм бот: Инфостарт бот

Публикация:

№ 1257654

Создание 29.06.20 18:00

Обновление 21.07.20 18:36

Статистика:

Просмотры 31037

Загрузки 47

Рейтинг 96

Комментарии 24

Характеристики:

Код открыт Да

Рубрики WEB-интеграция

Кому Программист

Тип файла Архив с данными

Платформа 1С v8.3

Конфигурация 1C:Бухгалтерия

Операционная система Не имеет значения

Страна Не имеет значения

Отрасль Не имеет значения

Налоги Не имеет значения

Вид учета Не имеет значения

Доступ к файлу Абонемент ($m)