我在设置 Swagger 时遇到问题。如何在我的 Node-Express 项目中实现 Swagger 来为现有 API 编写 API 文档? 我查看了 swagger、swagger-ui 和 swagger-ui-dist npm 包。但没有得到想要的输出。 我想使用 Swagger UI,但在配置中感到困惑。有人可以告诉我配置的分步指南吗? 需要帮忙。
对于初学者来说,一个不错的选择是安装 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
然后按照有关如何对控制器进行编码的其余说明进行操作。
最好的 npm 包是 swagger-autogen,它简化了为 API 生成 Swagger 文档的过程。
$ npm i swagger-autogen
npm swagger-autogen。
有关更多详细信息和示例,您可以访问 swagger-autogen GitHub 存储库。