Можно ли получить автономную версию документации Swagger для веб-сайта? - PullRequest
Новая
       25

Можно ли получить автономную версию документации Swagger для веб-сайта?

0 голосов
/ 02 мая 2018

localhost / swagger загружается, как и ожидалось, но у удаленного сервера / swagger возникают проблемы. Могу ли я сохранить автономную копию сгенерированной документации? Я могу просто отправить zip-файл нескольким пользователям, пока пытаюсь отладить удаленную проблему.

1 Ответ

0 голосов
/ 02 мая 2018

Существует множество способов предоставления документации по API своим пользователям, если вы по какой-либо причине не можете самостоятельно разместить Swagger UI. Все предложения предполагают, что у вас есть определение OpenAPI (Swagger), то есть файл YAML / JSON. Если вы не знаете, где находится файл YAML / JSON, вы можете вывести его с веб-страницы Swagger UI .

В произвольном порядке:

  1. Отправьте файл YAML / JSON своим пользователям и попросите их загрузить его в http://editor.swagger.io, чтобы просмотреть документы API.

  2. Импортируйте файл определения OpenAPI в SwaggerHub и разместите там свои документы по API.
    Раскрытие информации: SwaggerHub сделан компанией, в которой я работаю.

  3. Разместите файл определения OpenAPI на любом общедоступном веб-сервере, например создать гист на GitHub. Затем вы можете отобразить документы API, загрузив их в общедоступную демонстрацию пользовательского интерфейса Swagger, например: 

    http://petstore.swagger.io?url=YOUR_YAML_or_JSON_URL

    Если вы используете гист, убедитесь, что вы указали ссылку на сырой список (https://gist.githubusercontent.com/...). Если вы используете другой хостинг, убедитесь, что хост-сервер поддерживает CORS .

  4. "Упакуйте" пользовательский интерфейс Swagger и ваше определение OpenAPI в один файл без зависимостей , как описано здесь , и отправьте полученный файл своим пользователям.

  5. Создание статических документов HTML (не Swagger UI, а статическая HTML-страница без «пробного использования»): загрузите определение OpenAPI в http://editor.swagger.io,, затем выберите пункт меню Создать клиент> html или html2 или dynamic-html .

    Функция «Сгенерировать клиента» использует Swagger Codegen , поэтому вы также можете использовать CLI-версию Codegen для генерации желаемого результата.

  6. Хотите PDF? возможно преобразовать определения OpenAPI в PDF .

Смотри также:

...