Как добавить каталог API из HTTP-сервисов 1С?
В CorpWiki можно собрать справочник методов внешнего API и показать его на странице вики.
Один из способов - загрузить ZIP с папкой HTTPServices из выгрузки конфигурации 1С.
-
Откройте Настройки → Модули → Каталог API.
Пока записей нет - добавьте API кнопкой +. -
В выгрузке конфигурации 1С найдите папку HTTPServices и упакуйте её в ZIP.
Например файлHTTPServices.zipрядом с папкой. -
Создайте запись каталога:
задайте Ключ (1) и Название (2),
в поле Откуда взять описание API выберите ZIP / файлы (1С или OpenAPI) (3),
загрузите архив (4) и нажмите Сохранить (5).
При необходимости позже укажите базовый URL и авторизацию для кнопки «Попробовать». -
После сохранения в таблице появятся снимок (2) и время синхронизации (1).
Ниже откроется превью методов: поиск (3), фильтры по методу и доступу (4), список операций (5).
Кнопкой + у метода (6) можно создать страницу описания.
Спецификацию можно скачать (7). -
В превью методы сгруппированы по разделам (1).
У каждой операции видны метод (2), путь (3) и описание (4).
Можно добавить теги (5) или создать страницу описания (6).
Скачайте спецификацию в формате OpenAPI или Swagger (7). -
На странице вики вставьте макрос Каталог API.
Откройте вкладку Объекты данных (1), выберите макрос (2).
При необходимости включите Показать результат (3), Сворачивать группы (4) и Колонка тегов (5).
В Запись каталога укажите нужную запись (6) и нажмите Вставить. -
В записи каталога укажите Родитель описаний.
Нажмите Выбрать страницу (1) и укажите страницу (2), под которой будут создаваться описания методов.
Сохраните запись. -
На странице макрос показывает каталог: дерево разделов (1–2), поиск (3), фильтры (4–5), таблица методов (6–11) и теги (12).