如何使用swagger生成Node.js API文档

Question

我有一个使用Node.js / expressjs开发的应用程序。 一切正常。 现在，我需要使用Swagger生成API文档。 有一个模块swagger-node 。 我是否需要使用此模块重新编写整个应用程序，还是有其他解决方案来使用此模块？如果使用swagger-node，则swagger-ui的用途是什么？

Answer 1

从我所不能说的。 您应该能够按照描述的那样生成您的swagger项目，然后只需确保yaml文件中的信息指向您的代码使用的实际控制器和方法。

Answer 2

您可以创建一个与Swagger / OpenAPI兼容的独立yaml文件，因此可以将其呈现到Swagger文档中。 Swagger-UI对于创建此Yaml文件很有用。 Swagger还提供了各种工具来测试API和生成代码-要有效地使用它们，您将需要一种将yaml文件中的控制器/模型定义集成到现有代码库中的方法。

为了实现这种集成，我通常将现有的代码库公开为控制器功能的api，然后将其作为模块导入到由我记录的API生成的代码中。 这使我可以信任我的API文档，而不必承担将整个代码库移植到Swagger所需的目录结构中的负担。 我认为这是目前可用的最佳方法，但并不总是值得的。