简介
nodejs-api-boilerplate 是一个基于 Node.js 的 API 服务模板，提供了一整套 Node.js 和 Express.js 的模块化开发模式，旨在快速搭建项目的 API 服务层。它省去了繁琐的框架初始化和文件结构重复创建的步骤，可以快速搭建一个完整的 API 服务，同时具备一定的易扩展性和易维护性。
在这篇文章中，我们将会详细介绍如何使用 nodejs-api-boilerplate 包来创建一个完整的 API 服务。
安装
我们可以通过 NPM 来安装 nodejs-api-boilerplate 包：
npm install nodejs-api-boilerplate
创建项目
接下来，我们将基于 nodejs-api-boilerplate 包来创建一个新的项目。在项目根目录下输入下列指令，即可创建一个基于 nodejs-api-boilerplate 包的项目：
node node_modules/nodejs-api-boilerplate/init-project.js
然后根据提示进行输入，即可快速创建一个基于 nodejs-api-boilerplate 包的项目。
目录结构
创建成功后，我们将会得到下面的目录结构：
-- -------------------- ---- ------- --- ---------- - --- -------------- --- --- - --- ------ - --- ----------- - --- ---------- - --- ------ - --- ------ - --- ------ --- ------------
下面是这些文件和文件夹的解释：
- migrations：数据迁移文件夹。
- src/config：配置文件夹。
- src/controllers：控制器文件夹。
- src/migrations：数据迁移文件夹。
- src/models：模型文件夹。
- src/routes：路由文件夹。
- src/app.js：应用入口文件。
给应用添加中间件
Node.js 中的中间件提供了在请求和响应之间处理请求的能力，可以在应用层面提供一些重复逻辑的验证、请求参数的格式化、日志记录等功能，让我们可以更加专注于业务逻辑的实现。
在应用中添加中间件非常简单，只需要在 app.js 文件中加入中间件代码，即可。
例如，我们可以使用如下中间件来为应用添加 cors（跨域资源共享）特性：
const express = require('express');
const cors = require('cors');
const app = express();
app.use(cors());
// ...增加路由
nodejs-api-boilerplate 默认集成了一个 ping API，用于验证接口是否正常响应，我们也可以根据自己的需求增加新的路由。
在 src/routes 目录下创建一个新的路由文件，例如 users.js，并加入下面代码：
const express = require('express');
const router = express.Router();
const UserController = require('../controllers/user.controller');
router.get('/', UserController.getUsers);
router.post('/', UserController.createUser);
module.exports = router;然后在 src/app.js 文件中导入路由文件：
const usersRouter = require('./routes/users');
// ...
app.use('/users', usersRouter);这样我们就添加了一个新的 users 路由，可以通过访问 http://localhost:3000/users 来获取所有用户的信息。
使用模型和控制器
我们可以使用 nodejs-api-boilerplate 提供的模版代码来创建模型和控制器。在 src/models 目录下创建一个新的模型文件 user.js：
-- -------------------- ---- -------
----- - ----- - - ---------------------
-------------- - ----------- ---------- -- -
----- ---- ------- ----- -
------ ----------------- -
-
--
-----------
--------- -----------------
--------- -----------------
------ -----------------
-- -
----------
---------- -------
---
------ -----
--然后创建一个新的控制器文件 user.controller.js，并加入下面代码：
-- -------------------- ---- -------
----- - ---- - - ---------------------
------------------ - ----- ----- ---- -- -
--- -
----- - --------- ------ -------- - - ---------
----- ---- - ----- -------------
---------
------
---------
---
---------------
- ----- ----- -
-------------------
-----------------------
-
--
---------------- - ----- --- ---- -- -
--- -
----- ----- - ----- ---------------
----------------
- ----- ----- -
-------------------
-----------------------
-
--最后修改 users.js 路由文件：
const express = require('express');
const router = express.Router();
const UserController = require('../controllers/user.controller');
router.post('/', UserController.createUser);
router.get('/', UserController.getUsers);
module.exports = router;这样，我们就可以在 http://localhost:3000/users 访问该 API，来创建、删除、修改和获取用户的信息了。
小结
本文介绍了如何使用 nodejs-api-boilerplate 包来快速搭建一个完整的 Node.js API 服务，并添加了中间件、路由、模型、控制器的示例代码。相信读者对于 Node.js API 开发有了更深入的理解，希望这篇文章对你的开发工作和学习都有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005598181e8991b448d712a