如何使用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所需的目录结构中。我相信这是目前最好的方法，但并不值得。