Данный продукт предназначен для организации процесса документирования HTTP сервисов конфигураций написанных на платформе 1С:Предприятие.
- swagger - расширение конфигурации реализующее функциональность создания документации
- swagger-test - расширение для тестирования
В режиме конфигуратора создать расширение и выполнить загрузку конфигурации из файлов, указав при этом каталог swagger.
Опубликовать базу 1С:Предприятия на web-сервере. Обязательно проконтролировать, что cтоит настройка публикации "Публиковать HTTP сервисы расширений по умолчанию". Возможно после публикации или изменения настроек публикации потребуется перезапуск web-сервера. Открыть в браузере страницу http://<Адрес_опубликованной_базы_1С_Предприятия>/hs/swagger/index.html
Поиск описаний происходит среди общих модулей. Наименование общего модуля должно быть построено по шаблону: "<Наименование_HTTP_сервиса>Описание".
Пример создания описания можно посмотреть:
- swagger-test\CommonModules\SwagTest_Тестовый_HTTPСервисОписание
- swagger-test\CommonModules\ПередачаДанныхОписание
Реализовано через вызов обёрток "ПроверитьПараметры" и "ПроверитьОтвет" соответственно.
Для проверки входящих параметров:
РезультатПроверкиПараметров = Swag_ОбработкаHTTP.ПроверитьПараметры("SwagTest_Тестовый_HTTPСервис", "ТестовыйGET", Запрос);
Если Не ПустаяСтрока(РезультатПроверкиПараметров) Тогда
Возврат Swag_ОбработкаHTTP.ПолучитьОтветОшибки(РезультатПроверкиПараметров, Истина);
КонецЕсли;Для проверки ответа:
Возврат Swag_ОбработкаHTTP.ПроверитьОтвет("SwagTest_Тестовый_HTTPСервис", "ТестовыйGET", Ответ);| Функциональность | Статус | Обсуждение |
|---|---|---|
| Наличие описания в запросах | Запланировано | |
| Входящие параметры GET запросов | Запланировано | |
| Входящие параметры POST запросов | Запланировано | |
| Наличие описания в ответах | Реализовано | |
| Наличие и соответствие кода ответа | Реализовано | |
| Наличие и соответствие типа MIME в ответе | Реализовано | |
| Исходящие параметры | Запланировано | |
| Статический swagger.json | В работе | Ссылка |