在现代的 Web 开发中，接口返回数据格式的规范化已经受到越来越多的关注。而添加一些规范化返回数据的工具库可以帮助我们更快地开发和维护后端接口。
@edropin/response-utility 就是一个开源的工具库，旨在提供一些通用的接口返回处理方法来简化开发工作。
介绍
@edropin/response-utility 可以帮助我们处理一些常见的返回场景，例如错误处理、分页数据处理、检测请求参数是否合法等。其主要提供了以下几个模块：
handleError：统一处理接口错误的方法handleSuccess：统一处理成功返回数据的方法handlePaginate：分页数据处理handleValidationErrors：请求参数验证错误
通过应用 @edropin/response-utility ，我们可以把自己从涉及一些重复的代码片段中解放出来，实现开箱即用并提升开发效率。
使用
安装
npm install @edropin/response-utility
使用方法
-- -------------------- ---- -------
----- - ----------------------- -------------- ------------ --------------- ---------------------- - - -------------------------------------
----------------- ----- ----- ---- -- -
--- -
----- - ----- -------- - - ----------
----- ----- - ----- -------------- ----------
-- ------
----- ---------- - ---------------------------- --------- -------------
-- ------
-------------------------- ----------- -----
- ----- ------- -
-- ------
------------------ -----
-
---
------------------ ----- ---- -- -
--- -
----- - --------- -------- - - ---------
-- ----------
-------------------------------- ------------ -------------
-- ---------
----- ---- - --------------- ----------
-- ------
------------------- -----
- ----- ------- -
------------------ -----
-
---API
handleError(error, res, options)
处理接口错误信息的方法。
error：错误对象或错误字符串。res：express的响应对象。options.success：响应数据是否成功。options.message：响应数据附加消息。
// 处理错误信息
handleError(error, res, { message: 'Something went wrong.' });handleSuccess(data, res, options)
处理响应数据的方法。
data：要返回的数据。res：express的响应对象。options.success：响应数据是否成功。options.message：响应数据附加消息。
// 返回成功的响应数据
handleSuccess({ message: 'Success.' }, res, { success: true });handlePaginate(data, pagination, res, options)
处理分页数据的方法。
data：返回的分页数据。pagination：生成的分页对象。res：express的响应对象。options.success：响应数据是否成功。options.message：响应数据附加消息。options.filterFields：要显示的数据字段。
// 处理分页数据
handlePaginate(data, pagination, res, { filterFields: ['id', 'name'] });handleValidationErrors(data, required)
请求参数验证方法。
data：要验证的数据对象。required：必须的参数列表。
// 验证请求参数是否合法 handleValidationErrors(req.body, ['username', 'password']);
结论
@edropin/response-utility 是一个轻量级、非常有用的工具库。它不仅提供了一个简单但功能强大的 API，而且对我们的开发工作也提供了极大的帮助。
通过阅读本文，我们应该能够很容易地了解如何在自己的应用程序中使用它，并在自己的应用程序中获得更好的开发体验。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/edropin-response-utility