#wso2 #swagger #wso2-am
Вопрос:
Компания, в которой я работаю, разрабатывает API, позволяющий интегрировать наши приложения. Мы используем WSO2 AM в качестве нашего шлюза. Я должен задокументировать API, и они хотят, чтобы я использовал для этого WSO2 devportal. Но проблема в том, что они также хотят использовать Swagger для создания этой документации. Есть ли способ добавить развязность в документы API?
Комментарии:
1. Определение API swagger можно загрузить со страниц «Обзор» и «Опробовать» на портале разработчиков.
2. По умолчанию он допускает следующие форматы файлов — «pdf», «txt», «doc», «docx», «xls», «xlsx», «odt», «ods»
3. Может быть, вы можете разместить swagger в каком-нибудь месте и использовать этот URL-адрес в документах
Ответ №1:
Одним из обходных путей было бы добавить тип документа Markdown и добавить содержимое swagger в виде кода.
Таким образом, его можно просмотреть с портала Devportal, как показано ниже:
