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

21.07.20

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

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

Скачать файл

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

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

        


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

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

Требования

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

Установка

Проект на Gitlab

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

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

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

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

    Возврат оас_Сервис.Ответ(Запрос);
Разрабатываем спецификацию сервиса в формате OpenAPI v3.x, сохраняем в формате JSON

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

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

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

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

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

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

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

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

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

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

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

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

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

OpenAPI Swagger RestAPI HTTP сервисы

См. также

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

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

5040 руб.

04.05.2021    18988    10    16    

17

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

Подсистема интеграции Amo CRM с 1С: технические требования, порядок работы, возможности, доработки и обновления. Бесплатный период техподдержки - 1 месяц.

60000 руб.

07.05.2019    31863    62    40    

23

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

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

36000 руб.

03.08.2020    16739    15    19    

15

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

Внешняя обработка разрабатывалась для загрузки документов из Ветменеджер в 1С: Бухгалтерия 3.0

12000 руб.

02.02.2021    16995    45    49    

26

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

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

22656 руб.

25.05.2021    13368    36    8    

15
Комментарии
Подписаться на ответы Инфостарт бот Сортировка: Древо развёрнутое
Свернуть все
1. cprit 888 29.06.20 19:59 Сейчас в теме
Спасибо. То чего давно не хватало
Если автор не против, включу в универсальные инструменты 1С https://github.com/cpr1c/tools_ui_1c. Лицензия в репозитории позволяет
2. shmalevoz 307 29.06.20 20:15 Сейчас в теме
(1) Конечно не простив, включайте. У вас кстати ссылка битая. Верна https://github.com/cpr1c/tools_ui_1c
3. cprit 888 29.06.20 20:16 Сейчас в теме
(2) Видимо из-за скобок было. Поправил комментарий
4. Xershi 1504 29.06.20 22:18 Сейчас в теме
Насколько я понял это сервис, который 1 раз опубликовал и дальше пилишь справочники в предприятии и сразу генерируется документация?
У самого была такая идея, но не было задач для реализации конечного варианта.
Единственное авторизация есть на уровне сервиса или пилится кодом?
Аналогично разделение прав?
5. shmalevoz 307 29.06.20 22:46 Сейчас в теме
(4) Это прослойка между входящим запросом и конечным функционалом расположенным в обработках. Может обслуживать произвольное количество сервисов конфигурации. Для каждого сервиса своя спецификация.
На входе нужны
1. HTTP сервис, достаточно одного ресурса сервиса с шаблоном /* и одной конечной точкой с обработкой любого http метода. Обработчик точки может содержать только Возврат оас_Сервис.Ответ(Запрос)
2. Спецификацию OpenAPI v3 в формате json. Делается визуальными редакторами/руками
В обработке управления загружаем спецификацию, получаем шаблоны модулей конечных обработок. Создаем обработки, копируем шаблоны для конечных точек, наполняем их смыслом. Назначаем вызовы созданных обработок для конечных точек сервиса.
Расширение выполняет контроль соответствия входящего запроса загруженной спецификации. Единая точка проверки. И далее по настройкам вызывает конечные обработки реализующие логику точек. Есть события ПередОбработкойЗапроса, ПослеОбработкиЗапроса, обработчики назначаемы. Плюс на основании спецификации формирует документацию в распространенном юзерфрендли формате. Конечную логику (авторизацию) не изменяет.
Справочники не использует, все хранится в ХранилищеСистемныхНастроек
JohnyDeath; +1 Ответить
6. Xershi 1504 30.06.20 10:37 Сейчас в теме
(5) я так понимаю сделано чтобы снизить совместимость решения?
Лучше тогда сделать 3 варианта, конфигурация до 8.3.6, хранилище до момент использования справочников 8.3.11 и использование справочников в расширении.
Для заметок сделал публикацию Эволюция расширения конфигурации. С 8.3.11 доступно создавать свои справочники, а сейчас типовые уже 8.3.12+.
7. shmalevoz 307 30.06.20 10:52 Сейчас в теме
(6) Не вижу смысла пилить справочники для хранения набора условно константных соответствий с текстовым содержанием. Тем паче это данные расширения. Для этих целей очень неплохо подходит ХранилищеНастроек, как раз они там и хранятся. А совместимость с 8.3.9 сложилось достаточно исторически, при разработке базовых зависимостей, не помню уже какой там метод использовался, надо тесты запускать на младших платформах.
Относительно решения в конфигурации, то расширение в конфигурацию конвертируется легко - в Configuration.xml расширения меняется узел <Properties> на узел из конфигурации и загружается из файлов. Получается готовая конфигурация. Работающим на старых релизах + полчаса работы с перекурами.
8. botokash 391 30.06.20 11:03 Сейчас в теме
(7) А как происходит миграция загруженных настроек работы сервиса в РИБ?
9. Xershi 1504 30.06.20 11:25 Сейчас в теме
(8) судя из ответов автора никак. РИБ же переносит только пользовательские данные. А "ХранилищеНастроек" это служебные.
10. shmalevoz 307 30.06.20 11:32 Сейчас в теме
(9) Да, на РИБ текущая реализация не рассчитана, понадобится модификация чтения/записи настроек. Надо будет в будущем сделать адаптер хранения настроек чтобы управлять этим делом.
11. Xershi 1504 30.06.20 11:33 Сейчас в теме
(10) перейдя на 1 и 3 вариант это не понадобится.
12. shmalevoz 307 30.06.20 11:36 Сейчас в теме
(11) Как раз использование адаптера позволит не менять расширение, а вызывать необходимую выбранную реализацию хранения.
14. Xershi 1504 30.06.20 11:39 Сейчас в теме
(12) в любом случае хранение через справочники надежнее. Если инфа в хранилище побьется или будет удалена не очень приятно будет)
18. shmalevoz 307 01.07.20 10:17 Сейчас в теме
(14) В свежей версии появился адаптер хранения настроек, можно использовать любую собственную реализацию хранилища
17. shmalevoz 307 01.07.20 10:16 Сейчас в теме
(8) Теперь можно хранить настройки где угодно - делаем обработку с интерфейсом как в оас_НастройкиХранилищеСистемныхНастроек, выбираем ее адаптером хранения настроек в ОМ. Управление адаптерами (вид ОАС. Хранение настроек) и управление по чтению/записи настроек передается на нее. А там уж где хоть справочник, хоть регистр сведений, что угодно
13. shmalevoz 307 30.06.20 11:37 Сейчас в теме
А там уж кто какую схему хранения использует это дело хозяйское =)
15. malikov_pro 1310 30.06.20 14:58 Сейчас в теме
в модуле опечатка, style по идее.

Буду рад если поделитесь опытом ведения проекта в git и его сборки.
16. shmalevoz 307 30.06.20 15:09 Сейчас в теме
(15) Спасибо за поправку =)
19. shmalevoz 307 01.07.20 10:21 Сейчас в теме
(15) Не вопрос, поделюсь. Только вопрос больно расплывчатый. В личку пожалуйста, кажется вопрос объемен и лучше там обменяться контактами
20. zavbak 10.03.21 04:45 Сейчас в теме
Добрый день!
Падает по ошибке.

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

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


// Сохранение настроек. Раздельно по регионам использования
//
// Параметры: 
// 	Регион - Строка - Регион использования адаптеров
// 	Настройки - Структура - Сохраняемые настройки
//
Процедура Сохранить(Регион, Настройки) Экспорт
	
	#Если Сервер Тогда
		Если лг_Подсистема.АдминистрированиеДоступно() Тогда
			УстановитьПривилегированныйРежим(Истина);
			Коллекция	= ХранилищеСистемныхНастроек.Загрузить(ОбъектКлюч()
			, НастройкаКлюч()
			, 
			, ПользовательИмя());
			Коллекция		= ?(ом_Значение.СоответствиеЭто(Коллекция), Коллекция, Новый Соответствие());
			// Сами настройки храним фиксированными структурами
			Пользователи	= ом_Значение.СвойствоПолучить(Настройки, "Пользователи", Новый Соответствие());
			Если ом_Значение.СоответствиеЭто(Пользователи) Тогда
				Пользователи	= Новый ФиксированноеСоответствие(Пользователи);
			Иначе
				Если НЕ ом_Значение.ФиксированноеСоответствиеЭто(Пользователи) Тогда
					ВызватьИсключение лг_ПодсистемаТексты.МетодПараметрСтруктураОшибка();
				КонецЕсли;
			КонецЕсли;
			Хранение	= Новый Структура(Умолчание());
			ЗаполнитьЗначенияСвойств(Хранение, Настройки);
			Хранение.Вставить("Пользователи", Пользователи);
			Хранение	= Новый ФиксированнаяСтруктура(Хранение);
			Коллекция.Вставить(РегионИмя(Регион), Хранение);
			ХранилищеСистемныхНастроек.Сохранить(ОбъектКлюч()
			, НастройкаКлюч()
			, Коллекция
			, 
			, ПользовательИмя());
			ОбновитьПовторноИспользуемыеЗначения();
		Иначе
			ВызватьИсключение лг_ПодсистемаТексты.АдминистрированиеЗапрещено();
		КонецЕсли;
	#Иначе 
		ВызватьИсключение лг_ПодсистемаТексты.СредаВыполненияФункционалНедоступен();
	#КонецЕсли
	  
КонецПроцедуры // Сохранить
Показать
22. zavbak 17.09.21 04:39 Сейчас в теме
21. o.nikolaev 214 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 спецификациям.
Автору спасибо за идею
Оставьте свое сообщение