Я использую онлайн-редактор Swagger для документации нашего проекта API.
Сам проект размещен в нашем собственном экземпляре Gitlab, защищенном аутентификацией и разрешениями. Пример URL-адреса для аутентифицированных и авторизованных пользователей:
https://gitlab.company.local/имя-группы/имя-проекта/-/blob/main/subfolder/api.yml
Мы используем Redmine для решения проблем клиентов, поэтому он подключен к экземпляру Gitlab и также может получить доступ к файлам репозитория. Пример URL-адреса для аутентифицированных и авторизованных пользователей:
На данный момент я всегда копирую весь контент из файла и вставляю его в редактор Swagger, чтобы увидеть его. Наши вики-страницы содержат только ссылки на файлы .yml. Пользователи должны скопировать его в редактор вручную.
Было бы здорово, если бы вики-страница Redmine предоставила URL-адрес, указывающий на редактор Swagger, который импортирует этот файл либо из Redmine, либо из Gitlab (или один из них может предоставить его отображение).
Есть ли способ автоматизировать следующие шаги
- Аутентификация из редактора Swagger в одной из систем
- Импорт определения API из URL-адреса
- Создайте ссылку для общего доступа, которая всегда указывает на последнюю документацию по API.
Может быть, есть плагин Redmine, делающий именно это? Отображение редактора Swagger на основе связанного файла .yml.