前言
随着 RESTful API 设计的流行，Swagger 已成为最常用的 API 文档工具之一。generator-node-swagger 是一款使用 Swagger 规范生成 Node.js 项目骨架的工具，能够快速生成包含 Swagger 文档、Mocha 单元测试、ESLint 代码检查等功能的 Node.js 项目。本文将向你介绍如何使用 generator-node-swagger。
安装
generator-node-swagger 基于 Yeoman，因此需要先安装 Yeoman。
npm install -g yo
安装 generator-node-swagger。
npm install -g generator-node-swagger
现在，generator-node-swagger 就已经成功安装到你的电脑上了。
初始化项目
生成一个新的项目。
yo node-swagger
生成的项目中包含以下文件：
| 文件路径 | 描述 |
|---|---|
src/app.js |
Express 应用 |
src/routes.js |
Express 路由 |
src/config/index.js |
项目配置 |
src/swagger/swagger.yaml |
Swagger API 文档 |
test/test.js |
Mocha 单元测试 |
.eslintrc |
ESLint 代码规范 |
.gitignore |
Git 忽略列表 |
README.md |
项目说明 |
package.json |
项目依赖 |
配置Swagger
在 src/swagger/swagger.yaml 文件中编写 Swagger API 文档。例如：
-- -------------------- ---- -------
-------- -----
-----
-------- -----
------ -- ---
------
-------
----
-------- --- - ---- -- -----
----------
------
------------ ---------- --------
-----
- -----在 src/app.js 中添加 Swagger 中间件。
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger/swagger.yaml');
app.use('/swagger', swaggerUi.serve, swaggerUi.setup(swaggerDocument));现在，你可以打开 http://localhost:3000/swagger 查看 Swagger API 文档了。
编写 API 端点
在 src/routes.js 中编写 API 端点。例如：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------ - ----------------- -------------------- ----- ---- -- - ------------- --- -------------- - -------
运行项目
使用以下命令运行项目。
npm start
运行单元测试
使用以下命令运行 Mocha 单元测试。
npm test
ESLint 代码检查
使用以下命令运行 ESLint 代码检查。
npm run lint
结语
generator-node-swagger 是一款方便快捷的工具，能够帮助我们快速生成包含 Swagger 文档、Mocha 单元测试、ESLint 代码检查等功能的 Node.js 项目骨架。希望本文对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600566dd81e8991b448e32ea