У меня есть приложение, разработанное с помощью Node.js/expressjs. Он работает нормально. Теперь мне нужно создать документ API, используя Swagger. Существует модуль swagger-node. Нужно ли мне переписывать все приложение с помощью этого модуля или есть какое-либо другое решение для использования этого модуля, а также использование swagger-ui при использовании узла swagger.Как сгенерировать документы API-интерфейсов node.js с использованием swagger
Не из того, что я могу сказать. Вы должны иметь возможность генерировать свой проект swagger, как описано, а затем просто убедитесь, что информация в файле yaml указывает на фактические контроллеры и методы, используемые вашим кодом.
Вы можете создать автономный файл yaml, совместимый с Swagger/OpenAPI, который может быть представлен в документации Swagger. Swagger-UI полезен для создания этого файла yaml. Swagger также предлагает различные инструменты для тестирования API и генерации кода. Чтобы эффективно использовать их, вам понадобится метод интеграции определений контроллера/модели в ваш файл yaml в существующую кодовую базу.
Для достижения этой интеграции я обычно выставляю свою существующую кодовую базу как api функций контроллера, а затем импортирую ее как модуль в код, сгенерированный документированным API. Это позволяет мне доверять моей документации API без нагрузки на перенос всей моей базы кода в структуру каталогов Swagger. Я считаю, что это лучший доступный в настоящее время подход, но не всегда стоит того.