在开发前端项目的过程中，使用 Node.js 构建的后端服务是必不可少的。而在后端服务中，经常需要返回 JSON 格式的数据给前端进行页面渲染或者其他操作。在开发过程中，我们需要保持返回数据的统一格式以便于前端对数据进行处理。而 npm 包 express-api-formatter 就是用来解决这个问题的。
express-api-formatter 是什么？
express-api-formatter 是一个 Node.js 的中间件，在用户请求返回数据时，可以将返回的数据格式化成指定的格式，比如经常使用的规范格式 {'code': 0, 'msg': '', 'data': {}}。除了数据格式化外，它还有一些其他的功能，比如返回特定错误码的提示信息、快速处理错误等等。
安装 express-api-formatter
在使用 express-api-formatter 之前，需要先安装它。可以通过 npm 安装，如下所示：
npm install express-api-formatter --save
使用 express-api-formatter
安装好之后，将 express-api-formatter 引入到你的 express 项目中。比如在 app.js 中使用：
-- -------------------- ---- -------
----- ------- - -------------------
----- --------- - ---------------------------------
----- --- - ----------
-------------------
------- ----
---------- ------
--------- --------
---------- ------ ----- -------- -- -
------ -
-----
-----
-------
--
-
----以上代码意思是：当用户请求返回数据时，会将数据格式化成 {code: number, data: object, message: string} 的标准格式，其中 code 是后端返回给前端的状态码，data 是返回给前端的数据，message 是返回给前端的提示信息。
使用示例
下面是一个简单的使用示例，在服务端定义一个接口，返回一些测试数据：
-- -------------------- ---- -------
-- ---------------
------------------- ------------- ---- ----- -
----- ---- - -
------ ----- ---- ----
------ ----- ---- ----
------ ----- ---- ---
--
--------------
---在客户端使用 ajax 请求这个接口并将返回的数据输出：
$.get('/test', function(res) {
console.log(res);
});输出结果如下：
-- -------------------- ---- -------
-
------- ----
------- -
-
------- -----
------ --
--
-
------- -----
------ --
--
-
------- -----
------ --
-
-
-可以看到，返回的数据符合预期的规范格式，前端可以很方便的对返回的数据进行处理和展示。
结语
通过上述示例，可以看到 express-api-formatter 的使用非常简单。它可以很好的帮助我们保持返回数据的统一格式，提高开发效率，减少出错机率。在开发项目时，可以使用该包来提高推动项目的快速开发和上线。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600556d881e8991b448d3b19