Swagger для 1С.

21.10.19

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

Решение для формирования Swagger спецификаций, описывающих HTTP сервисы конфигураций 1С.

Оглавление:

Введение
Простой пример
Инструменты
Настройка Simple-UI
Первый результат
Делаем красиво
Заключение
Благодарности

 

Введение

В данной статья я хотел бы показать решение для создания Swagger спецификаций на основании конфигураций 1С.

Что же такое Swagger спецификация? Небольшая выдержка с Wiki:

The OpenAPI Specification (изначально известная как Swagger Specification)— формализованная спецификация и экосистема множества инструментов, предоставляющая интерфейс между front-end системами, кодом библиотек низкого уровня и коммерческими решениями в виде API. Вместе с тем, спецификация построена таким образом, что не зависит от языков программирования, и удобна в использовании как человеком, так и машиной.

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

Все описание создаваемых нами HTTP сервисов на платформе 1С должно бы выглядеть так:

Это позволит публиковать документацию сервисов 1С в общепринятом, стандартизованном формате, общаясь с внешними командами общепринятом в среде профессионалов языке спецификаций API, не дополняя общение постыдными фразами вида "ой, у нас 1С, у нас нет Swagger, наш программист сейчас напишет все в Ворде". Swagger - это документация которая не врет и не отстает от основного кода, поскольку является его продолжением и создается автоматически. Никаких больше "документаций сервиса в Word!"

Что бы получить желаемый результат, мной была создана OneScript библиотека - swagger, которая реализует формирование второй редакции OpenAPI спецификации.

 

Простой пример

Более детальное описание возможностей библиотеки swagger я рассмотрю на примере создания нового HTTP сервиса в произвольной конфигурации. Нижеизложенный текст будет показывать сопоставление содержимого метаданных/модулей конфигурации с визуальным представлением генерируемой спецификации.

 

Постановка задачи

Возникла потребность создать API управления доступом в систему 1С. Необходимые возможности:

  • Получить список всех пользователей
  • Получить все свойства пользователя
  • Изменить все свойства пользователя
  • Изменить одно свойство пользователя
  • Создать нового пользователя
  • Удалить существующего пользователя

 

Подготовка метаданных

Добавим в дерево метаданных новый HTTP сервис:

  • Имя UserAPI (имя сервиса)
  • Синоним API управления доступом (описание сервиса)
  • Комментарий 1.0 (версия сервиса)

Общее описание сервиса

Создадим наборы шаблонов URL:

  1. Для получение списка пользователей:
  • Имя ПользователиСписок
  • Синоним user (tag)
  • Шаблон /user/list (path)
  • Методы:
    • HTTP метод GET
      • Комментарий Получить список пользователей (определение операции)

  1. Для работы с конкретным пользователем:
  • Имя Пользователь
  • Синоним user (tag)
  • Шаблон /user/{userID}
  • Методы:
    • HTTP метод GET
      • Комментарий Получить свойства пользователя (определение операции)
    • HTTP метод PATCH
      • Комментарий Изменить свойство пользователя (определение операции)
    • HTTP метод PUT
      • Комментарий Изменить все свойства пользователя (определение операции)
    • HTTP метод DELETE
      • Комментарий Удалить пользователя (определение операции)

  1. Для создания нового пользователя:
  • Имя ПользовательНовый
  • Синоним user (tag)
  • Шаблон /user
  • Методы:
    • HTTP метод POST
      • Комментарий Создать нового пользователя (определение операции)

Так же платформой были созданы обработчики в модуле HTTP сервиса:

 
 Модуль HTTP сервиса

Болванка нашего сервиса готова.  Выгрузим конфигурацию в файлы, используя каталог D:\ПримерКонфигурация\. Далее займемся установкой и настройкой необходимых инструментов.

 

Инструменты

Установим или обновим OneScript до актуальной версии (на момент написания статьи 1.1.1). Далее установим библиотеку swagger:

opm install swagger

Так же потребуется наличие IIS на своей машине или ином сервере. Но все примеры ниже будут в рамках localhost.

Скачаем содержимое папки dist из официального репозитория Swagger-UI.

Скачаем содержимое папки simple-ui из репозитория библиотеки swagger.

 

Настройка Simple-UI

Simple-UI представляет собой пример каталогизатора спецификаций, позволяющий хранить, актуализировать и отдавать спецификации по запросу. Выполнен в виде HTTP сервисов на OneScript. Так же приведен пример модификацию Swagger-UI для взаимодействия с нашим каталогизатором.

 

Развертывание spec-admin

Описание, создание и публикация HTTP сервисов на OneScript хорошо рассмотрены тут и тут.

В IIS добавим новое приложение:

 

Проверим готовность сервиса обычным GET запросом на:

http://localhost/onec-swagger-admin/list.os

В теле ответа от сервиса мы должны получить "[]".

 

Развертывание Swagger-UI

В IIS добавим новый виртуальный каталог:

Проверим в браузере:

Далее заменим файл index.html в каталоге onec-swagger-ui на аналогичный файл из Simple-UI.

Завершающим этапом откроем в любом редакторе новый файл index.html и заменим в строчке:

var admin_url = 'http://localhost/onec-swagger-admin/'

"localhost" на адрес вашего IIS сервера:

var admin_url = 'http://ВашСерверIIS/onec-swagger-admin/'

 

Первый результат

Из репозитория библиотеки swagger скачаем скрипт upload.os. У нас уже есть выгруженная в файлы конфигурация D:\ПримерКонфигурация\.

Открываем терминал и выполним следующую команду:

oscript upload.os -name SimpleAPI -path D:\ПримерКонфигурация\ -type xml -adminurl localhost/onec-swagger-admin/

Если команда прошла без ошибок, любуемся результатом на http://localhost/onec-swagger-ui/

 

Делаем красиво

Рассмотрим более подробное описание метода PUT /user/{userID}:

Как мы видим, библиотекой swagger в сформированной спецификации явно описан параметр userID с пометкой входящий и расположением в пути запроса. Так же по умолчанию подставляется единственный код ответа сервиса - 200 (см. стандарт RFC7231) и тип данных в теле ответа считается обычным текстом (см. стандарт RFC6838).

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

 

Комментарий по стандарту

В стандартах разработки на ИТС у нас есть такой замечательный документ. Он достаточно подробно показывает как нам правильно описывать свои процедуры и функции.

Воспользуемся данным стандартом, и добавим подробное описание функций в модуле сервиса:

 
 Модуль HTTP сервиса

Обновим спецификацию, проверяем что в каждый метод добавилось описание:

Следующим шагом опишем входящие параметры, которые явно заданы в пути (шаблон /user/{userID}):

 
 Модуль HTTP сервиса

Обновим спецификацию, проверяем описание параметра userID:

Так как в логике работы некоторых методов подразумевается получение данных из тела запроса или в строке самого запроса, добавим в соответствующие комментарии:

  • для методов PUT и POST добавим описание параметра body (ключ-слово библиотеки swagger)
  • для метода PATCH добавим описание параметров property и value (напомню, логика обработки данного метода подразумевает изменение конкретного свойства)
 
 Модуль HTTP сервиса

Обновим спецификацию, проверяем описание параметра body:

а так же для метода PATCH:

 

Комментарий не по стандарту

Рассмотрим ситуацию, что по переданному userID пользователь в системе не был найден. Тогда наш сервис должен вернуть код ответа 404. А если в процессе изменения свойства пользователя в базе 1С произошла ошибка (все же пользуются транзакцией с попыткой) то вернем код ответа 500.

Поскольку потребность описать коды ответов HTTP сервиса не предусмотрена в стандарте ИТС, то в комментарии будем добавлять "нестандартный" блок:

// Коды ответов:
//   XXX - Описание
//

где XXX - код ответа по стандарту RFC7231.

Дописываем изменения в модуле:

 
 Модуль HTTP сервиса

Обновим спецификацию, проверяем блоки Responses:

 

Заключение

На данный момент, библиотека swagger выпущена как минимально жизнеспособный продукт (MVP). В планах стоят следующие задачи:

  1. Добавить поддержку формирования спецификации для конфигурации в формате проекта EDT.
  2. Найти приемлемый способ описания схемы объектов API в конфигурации 1С. Пока я вижу этот момент как описание в комментарии, примерно следующим образом:
// Параметры:
//   body - Объект(json):UserType - Пользователь
//    * Name - Строка - Имя
//    * ShowInList - Булево - Показывать в списке
//    * Roles - Массив из Строка - перечень ролей

что будет соответствовать объекту в json:

{
    "Name": "Name",
    "ShowInList": true,
    "Roles": [
        "Role"
    ]
}

и в спецификации будет описание в схеме:

{
    "definitions": {
        "User": {
            "type": "object",
            "discriminator": "UserType",
            "properties": {
                "Name": {
                    "type": "string"
                },
                "ShowInList": {
                    "type": "boolean"
                },
                "Roles": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "required": [
                "Name",
                "ShowInList",
                "Roles"
            ]
        }
    }
}
  1. Научиться связывать спецификации с настройками публикации тестовых база и попробовать автотесты.

Буду рад любой конструктивной критике и предложениям.

 

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

Особую благодарность выражаю Овсянкину Андрею за помощь в подготовке данной статьи, а сообществу OneScript за отличный продукт и прекрасное комьюнити.

 

P.S. Никаких файлов для загрузки, все необходимое доступно по приведенным в статье ссылкам.

OneScript Swagger Swagger-UI

См. также

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

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

36000 руб.

03.08.2020    17879    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    20004    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    1489    1    0    

3
Комментарии
Подписаться на ответы Инфостарт бот Сортировка: Древо развёрнутое
Свернуть все
1. пользователь 21.10.19 11:24
2. chg 21.10.19 11:30 Сейчас в теме
3. ZeratulAyuris 21.10.19 11:43 Сейчас в теме
Очень своевременно, спасибо!
4. Жолтокнижниг 259 21.10.19 13:53 Сейчас в теме
Качественно.
Даешь swagger в 1с массы.
5. tanat74 68 21.10.19 15:51 Сейчас в теме
Большое спасибо. Очень давно искал такой механизм.
6. CodeNull 23.10.19 17:41 Сейчас в теме
Здравствуйте. Весьма годный и нужный инструмент. Но как вы сами написали, не хватает описания body для post запросов. Например, в нашем проекте post запросы это самая объемная часть, body некоторых весьма сложный по структуре (много полей и вложимость).

А что насчёт описания ответа (возвращаемое значение)?
7. botokash 395 24.10.19 05:32 Сейчас в теме
(6) Как я писал в заключении описание схемы данных, как в теле запроса, так и в теле ответа, обязательно будет в следующих релизах библиотеки. Сейчас вопрос стоит в том, как лучше сделать. Ну и конечно вопрос времени, пока занят другим проектом. Можете добавить репозиторий библиотеки на гитхабе в наблюдение, не пропустите обновление )
8. Evil Beaver 8246 10.12.19 15:19 Сейчас в теме
Столкнулся с обратной задачей - есть готовая спецификация API в виде OpenApi json и нужно сделать веб-сервис. Для многих языков есть готовые генераторы классов под такую спецификацию. Может автор и для 1С сделает? Надо всего-то XML с описанием веб-сервиса сгенерировать и модуль с заглушками методов. А потом это можно в исходники 1С подложить и готово!
9. botokash 395 11.12.19 06:45 Сейчас в теме
(8) Автор с самого начала задумывался над кодогенерацией) Пока проблема с наличием свободного времени.
34. Nikola23 706 26.05.20 09:04 Сейчас в теме
(8) Дай погонять описание. Может что получится.
35. Evil Beaver 8246 26.05.20 12:46 Сейчас в теме
36. Nikola23 706 26.05.20 17:10 Сейчас в теме
(35) Вы пишите: "есть готовая спецификация API в виде OpenApi json и нужно сделать веб-сервис".
Вот ту самую спецификацию можете скинуть?
37. malikov_pro 1325 15.06.20 13:00 Сейчас в теме
(8)
Надо всего-то XML с описанием веб-сервиса сгенерировать и модуль с заглушками методов.

Может лучше роуты кодом описать? У меня была попытка https://infostart.ru/public/1131305/, но народ не отреагировал.
Если чисто кодом то и в OneScript переложить не проблема.

Для начала нужны требования к результатам генератора.
10. 19077 14.01.20 18:13 Сейчас в теме
Очень нужная штука, больше нет новостей?
11. SLV66 28.01.20 13:31 Сейчас в теме
При установке столкнулись с ошибкой

C:\Program Files\OneScript\bin>opm install swagger
ПРЕДУПРЕЖДЕНИЕ - Ошибка получения списка пакетов с хаба ОсновнойСерверПакетов по причине {Модуль C:\
Program Files\OneScript\lib\opm\src\core\Классы\СерверПакетов.os / Ошибка в строке: 94 / Ошибка подк
лючения к зеркалу }
ПРЕДУПРЕЖДЕНИЕ - Ошибка получения списка пакетов с хаба ЗапаснойСерверПакетов по причине {Модуль C:\
Program Files\OneScript\lib\opm\src\core\Классы\СерверПакетов.os / Ошибка в строке: 94 / Ошибка подк
лючения к зеркалу }
КРИТИЧНАЯОШИБКА - {Модуль C:\Program Files\OneScript\lib\opm\src\core\Классы\МенеджерПолученияПак­ето
в.os / Ошибка в строке: 18 / Ошибка установки пакета swagger: Пакет не найден}
12. botokash 395 28.01.20 13:35 Сейчас в теме
(11) Добрый день. Могу предположить, что не работают хабы пакетов. Можете скачать packagedef тут.
13. CodeNull 30.01.20 05:14 Сейчас в теме
(11) Проверьте настройки прокси. У меня были с этим проблемы когда пытался использовать opm на работе. Решается конфигурирование менеджера пакетов либо хардкодингом: https://github.com/oscript-library/opm/issues/152#issuecomment-487804579
21. SLV66 30.01.20 12:01 Сейчас в теме
14. SLV66 30.01.20 08:09 Сейчас в теме
после подмены указанного файла ошибки не уходят (

C:\Program Files\OneScript\bin>opm install swagger
{Модуль C:\Program Files\OneScript\lib\opm\src\core\Классы\metadataparser.os / Ошибка в строке: 4,4
/ Библиотека не найдена xml-parser}
15. botokash 395 30.01.20 08:16 Сейчас в теме
(14) проверил, пакет доступен для установки с хаба:
PS C:\WINDOWS\system32> opm install swagger
ИНФОРМАЦИЯ - Скачиваю файл: swagger.ospx
ИНФОРМАЦИЯ - Устанавливаю пакет swagger
ИНФОРМАЦИЯ - Установка завершена
ИНФОРМАЦИЯ - Устанавливаю зависимость: fs
ИНФОРМАЦИЯ - Скачиваю файл: fs-1.0.0.ospx
ИНФОРМАЦИЯ - Устанавливаю пакет fs
ИНФОРМАЦИЯ - Установка завершена
ИНФОРМАЦИЯ - Устанавливаю зависимость: xml-parser
ИНФОРМАЦИЯ - xml-parser уже установлен. Пропускаем.
ИНФОРМАЦИЯ - Устанавливаю зависимость: json
ИНФОРМАЦИЯ - Скачиваю файл: json-1.1.1.ospx
ИНФОРМАЦИЯ - Устанавливаю пакет json
ИНФОРМАЦИЯ - Установка завершена
Показать


Все зависимости явно видны.
16. CodeNull 30.01.20 08:19 Сейчас в теме
(15) Тоже проверил, установка прошла успешно.

(14) Какая версия oscript и opm?

# opm -v
0.15.3
# oscript -v
1.1.1.44
17. пользователь 30.01.20 11:48
Сообщение было скрыто модератором.
...
18. SLV66 30.01.20 11:51 Сейчас в теме
C:\Program Files\OneScript\bin>opm -v
{Модуль C:\Program Files\OneScript\lib\opm\src\core\Классы\metadataparser.os / Ошибка в строке: 4,4
/ Библиотека не найдена xml-parser}
20. botokash 395 30.01.20 11:59 Сейчас в теме
(18) ну тут очевидно, нужно установить пакет xml-parser
19. SLV66 30.01.20 11:52 Сейчас в теме
C:\Program Files\OneScript\bin>oscript -v
1.2.0.92
22. SLV66 30.01.20 12:02 Сейчас в теме
а нельзя ли скопировать этот проект и вставить ?
23. botokash 395 30.01.20 12:14 Сейчас в теме
(22) попробуйте этот архив распаковать в "C:\Program Files (x86)\OneScript\lib"
Прикрепленные файлы:
swagger.rar
24. SLV66 30.01.20 12:22 Сейчас в теме
скопировал

opm install swagger Это делать получается не нужно?
25. SLV66 30.01.20 12:23 Сейчас в теме
C:\Windows\system32>oscript C:\inetpub\wwwroot\Onescript\upload.os -name SimpleAPI -path C:\MP_1C\Co
nf\Conf_file\ -type xml -adminurl http://localhost/oosw/
{Модуль C:\inetpub\wwwroot\Onescript\upload.os / Ошибка в строке: 5,5 / Библиотека не найдена swagge
r}
26. botokash 395 30.01.20 13:45 Сейчас в теме
(25) Как мне кажется, у вас проблема не с моей библиотекой. В телеграмме есть группа oscript_library, обратитесь лучше туда. В комментариях под статьей не место для поиска ответов на ваши проблемы.
27. tdr 11.02.20 12:43 Сейчас в теме
Установил сие на хттп сервис генерации актов сверки у заказчика.
Хороший инструмент для описания api у сервиса
Но заметно уступающий тому же Fiddler для отладки и мониторинга работы сервиса

пришел к выводу, что удобнее непосредственно тут править описание сервиса сразу на YAML, нежели на JSON, и итоговый результат вставлять в файл сервиса с расширением json

https://prnt.sc/r0m9l5

чем оформлять в 1С потом небыстро выгружать и обрабатывать парсером.
28. tdr 11.02.20 12:52 Сейчас в теме
Swagger не умеет отображать ответы сервисов, в теле которых есть JSON (у меня массив строк)
вот пример:
https://prnt.sc/r0mf2v
29. qwed557 30 11.03.20 15:54 Сейчас в теме
Здравствуйте, не подскажете куда копать?
Выходит такая ошибка
Ошибка HTTP 500.19 — Internal Server Error

Ошибка конфигурации Данный раздел конфигурации не может использоваться на этом пути. Это происходит, когда раздел блокирован на родительском уровне. Блокировка происходит либо по умолчанию (overrideModeDefault="Deny"), либо устанавливается непосредственно при помощи тега расположения с overrideMode="Deny" или наследуемым свойством allowOverride="false".
Файл конфигурации \\?\C:\swagger\simple-ui\spec-admin\web.config

права на папку для пользователя IIS есть, что еще нужно настроить?
30. qwed557 30 12.03.20 08:48 Сейчас в теме
Вот полный скрин с ошибкой, кто подскажет что поправить надо? На двух разных компах одна и та же ошибка.
Прикрепленные файлы:
31. botokash 395 12.03.20 09:19 Сейчас в теме
(30) Честно говоря не силен в данном вопросе.
32. qwed557 30 12.03.20 09:21 Сейчас в теме
Доустановил компоненты .Net Framework 4.7
теперь выходит следующая ошибка:
Прикрепленные файлы:
KUAvanesov; VVi3ard; +2 Ответить
33. qwed557 30 12.03.20 11:08 Сейчас в теме
все, разобрался, надо было папаку bin скопировать в каталог spec-admin
38. koln 05.07.20 14:30 Сейчас в теме
(33)Возникла такая же проблема. Ваше решение помогло. Уточню только, что папка bin из каталога OneScript, в моем случае C:\Program Files\OneScript
KUAvanesov; VVi3ard; +2 Ответить
39. koln 06.07.20 09:27 Сейчас в теме
При запуске скрипта
oscript upload.os -name SimpleAPI -path D:\ПримерКонфигурация\ -type xml -adminurl localhost/onec-swagger-admin/
возникла ошибка
Не найден тип вызова в блоке! {C:\Program Files (x86)\OneScript\lib\swagger\src\Классы\codeparser.os /Ошибка в строке 127 / Внешнее исключение (System.ArgumentOutOfRangeException):Заданный аргумент находится вне диапазона допустимых значений. Имя параметра: i}
С чем это может быть связано и как исправить?
Прикрепленные файлы:
40. koln 07.07.20 12:15 Сейчас в теме
(39)Проблема решена. Как оказалось, для одного шаблона метод обработчика был полностью закомментирован (не использовался). Именно поэтому и не удавалось найти и сопоставить обработчик по указанному в шаблоне имени.
41. nicolya 4 13.07.20 13:01 Сейчас в теме
Добрый день! Добавил в IIS приложение и при проверке запросом http://localhost/onec-swagger-admin/list.os получаю следующую ошибку:
Ошибка HTTP 404.17 — Not Found
Содержимое запроса является сценарием и не будет обрабатываться обработчиком файла статистики.

Может, сталкивался кто-нибудь, подскажите куда копать? Спасибо
Прикрепленные файлы:
43. Jeka44 30.09.20 17:28 Сейчас в теме
(41) столкнулся с этой же проблемой. Вы смогли ее победить?
44. Jeka44 30.09.20 17:36 Сейчас в теме
(43)отвечу сам себе: чтобы исправить эту ошибку надо доустановить компоненты Windows Службы WCF
52. AlexZm 02.02.22 00:17 Сейчас в теме
(44) А можно подробнее? На windows server 2008 R2 словил ошибку и не могу побороть.
56. Jeka44 10.02.22 10:02 Сейчас в теме
(52)По моему это
Прикрепленные файлы:
53. AlexZm 02.02.22 00:20 Сейчас в теме
(41) Удалось ли победить проблему?
54. ManOfAsgard 07.02.22 09:16 Сейчас в теме
(53) Я не знаю, насколько это актуально, но решение следующее, нашёл здесь - https://infostart.ru/1c/articles/727311/.
Вкратце - нужно приложению onec-swagger-admin указать пул .NET v4.5 Classic, а в каталог приложения положить каталог bin с либами из скачанного архива OneScript.
Прикрепленные файлы:
KUAvanesov; AlexZm; +2 Ответить
55. AlexZm 08.02.22 01:57 Сейчас в теме
(54) Спасибо большое! Получилось.
42. VVi3ard 52 17.08.20 10:15 Сейчас в теме
(0) Полезная статья.
На мой взгляд было бы лучше разбить её на 2 части:
1. Получение описания OpenApi;
2. Отображение этого описания;

Не всем нужно локально поднимать swagger и отображать описание, для начала достаточно было бы просто получить спецификацию и работать с ней на https://swagger.io.

Подскажите если мне не нужно локально хостить swagger, как просто получить сгенерированное описание?
bubnov; artesk; user1284675; +3 Ответить
45. Jeka44 30.09.20 17:44 Сейчас в теме
Столкнулся с ошибкой "Ошибка HTTP 500.23 — Internal Server Error
Обнаружены значения параметров ASP.NET, которые неприменимы в интегрированном режиме управляемого конвейера."
Может кто подскажет как ее победить?
46. Jeka44 30.09.20 17:47 Сейчас в теме
(45)Опять, как только спросил, так сразу разобрался. Не тот пул приложений выбрал
47. amyd 94 18.02.21 12:59 Сейчас в теме
Крутышка по всем статьям!
за задрался в NotePad делать описание.!
однозначно плюс
48. eugeniezheludkov 45 22.02.21 17:42 Сейчас в теме
судя по закоментированному коду //Результат.Вставить("definitions");
сложных типов данных нет , т.е входные выходные данные могут быть лишь строки числа массивы (строк , чисел) и больше ничего (((( а еще булево .
49. SagittariusA 25.03.21 10:24 Сейчас в теме
50. eugeniezheludkov 45 20.04.21 04:32 Сейчас в теме
с кодировкой utf-8 эти скрипты из статьи не дружат от слова совсем.
учитывая, что эта разработка не понимает/не распарсивает xdto, сложные типы не понимает. как на входе так и на выходе лишь простые типы , на выходе так вообще plain\text вместо нормального описания пакета.
возникает вопрос: кто нибудь вообще воспользовался тем что описано в статье ?
как по мне описать методы у котрых на входе string и на выходе string можно было бы и в блокнотике
51. Ibrogim 1328 07.09.21 15:53 Сейчас в теме
Круто. Думал уже писать, но нашёл эту крутатень!
57. OlegK 55 22.05.24 23:19 Сейчас в теме
Добрый день!

Пытаемся все повторить, но споткнулись на установке oscript upload.os

Ошибка:
oscript C:\inetpub\wwwroot\swagger-master\simple-ui\upload.os -name Swagger -path e:\Temp\SimpleConfig.cf -type xml -adminurl https://rps-wy.xyz/swagger-ui/dist/ -encoding=UTF-8

{?????? C:\inetpub\wwwroot\swagger-master\simple-ui\upload.os / ?????? ? ??????: 2,0 / ?????????? ?? ???????: 'cmdline'}


И непонятно что с кодировкой делать. Никак не получется понять, что за ошибка или сообщение.

Спасибо!
Прикрепленные файлы:
58. OlegK 55 23.05.24 22:46 Сейчас в теме
(57) Вот ошибка. Не хватает библиотеки cmdline
Что это? Как установить?

Спасибо!
Прикрепленные файлы:
59. yuliia_fnf 02.06.24 05:59 Сейчас в теме
Привет. Спасибо за описание, разворачивали на сервере и все шло отлично до шага загрузки конфигурации с помощью oscript.
Команда у меня выглядит вот так: - oscript tools\upload.os -name TEST_SERVICE -path src\configuration -type json -adminurl http://localhost/onec-swagger-admin/ -host 127.0.0.1 -onecbase TEST_BASE
Команда прошла без ошибок, но вместо результата - "No API definition provided" (до этого был шаблон petStore - как по инструкции).
Подскажите пожалуйста в какую сторону копать, уже все варианты по разным статьям испробовала и на этом моменте постоянно спотыкаемся. Может быть в файлах с гита нужно дополнительно что-то заполнить?
Прикрепленные файлы:
60. OlegK 55 02.06.24 06:10 Сейчас в теме
Добрый день!

В продолжение (57) (58)
Делали все по инструкции, споткнулись на шаге загрузки конфигурации с oscript. Разворачивали на сервере, поэтому наша команда выглядит примерно вот так:
oscript d:\Oscript\upload.os -name SwaggerAPI -path e:\Temp\EmptyConfig.cf -type xml -adminurl http://localhost/onec-swagger-admin/ -host 127.0.0.1 -onecbase TEST_BASE
команда проходит без ошибок, но вместо структура как в примере получаем "No API definition provided" (см.скрин). Пробовали и на болванке как в примере и на http c прописанными структурами возврата - ничего.
До этого шага все соответствовало описанию в статье (отображался шаблон PetStore).
Подскажите плз в какую сторону копать? Может в файлах с гита нужно что-то дополнительно заполнить?
Прикрепленные файлы:
Оставьте свое сообщение