node.js - NodeJS 中的 Swagger API 文档

Question

我在设置 Swagger 时遇到了问题。如何在我的 node-express 项目中实现 Swagger 来为现有 API 编写 API Doc？我看过 swagger、swagger-ui 和 swagger-ui-dist npm 包。但没有得到想要的输出。我想使用 Swagger UI，但对配置感到困惑。谁能告诉我配置的分步指南？需要帮忙。

Answer 1

对于初学者来说，一个不错的选择是安装 Swagger NPM 包https://www.npmjs.com/package/swagger并按照说明进行操作。

概述：

// install
npm install -g swagger

// create a new project
swagger project create hello-world

// edit your API using the Swagger UI
swagger project edit

然后按照有关如何编码控制器的其余说明进行操作。

Answer 2

基本安装后：

这是一个分步指南。

• 将 Swagger 添加到现有的 Node.js 项目
• 将 Swagger UI 与任何代码库一起使用

希望这是您正在寻找的。