«Prettier» расширение пользовательского интерфейса Swagger для документации веб-сайтов
мы используем swagger.io для документирования нашего REST API. Не могли бы вы порекомендовать, как сделать его еще красивее для конечных пользователей после его публикации на подстранице документации нашего веб-сайта? Мы хотим включить несколько схем / изображений, и мне очень нравится, как, например, структурирована эта документация: https://developer.xero.com/documentation/api/api-overview . Конечно, мы хотим, чтобы он создавался самостоятельно из кода + через WYSIWYG будет добавлено дополнительное описание.
Большое спасибо за ваш совет и удачного дня!PS: Извините за мой язык, я не инженер / техник :)
1 ответ
Я работаю с XeroAPI - связанная документация фактически находится в процессе выпуска и создается непосредственно из нашей спецификации OpenAPI.
У нас также есть наши документы SDK, автоматически сгенерированные с использованием OAS (OpenAPISpec), показывающие конкретные примеры кода для каждого поддерживаемого нами языкового SDK.
https://xeroapi.github.io/xero-node/accounting/index.html
Вы можете узнать больше о создании документации из репозитория openapi-generator и провести небольшое исследование HtmlDocs2.