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

基本安装后：

这是逐步指南。

• Adding Swagger To Existing Node.js Project
• Using Swagger UI with any codebase

希望这就是您想要的。