Express.js 是 Javascript 中一款流行的 web 应用框架，它能够快速地搭建一个 web 服务器，以便提供接口服务，对前端开发人员而言，深入理解 Express.js 的 API 设计规范，对于提高前端开发质量有着不可替代的作用。
正确地设计 API，不仅可以保证代码的可维护性，还能提高前后端开发的协作效率，同时也可以更好地遵循 RESTful API 的规范，让接口更为稳定和灵活。
下面我们将介绍在使用 Express.js 时应该如何设计 API，内容将包括 API 设计思路、 API 命名规范、 API 参数传递、 API 错误处理等方面。
API 设计思路
在设计 API 时，可以考虑以下因素：
- API 的设计原则：RESTful，请求方法（GET、POST、PUT、DELETE），路由和路径等。
- API 的使用场景：从用户角度出发，考虑 API 的使用方式和流程。
- API 的易用性：API 必须符合开发者对于易用性的期望，同时也要考虑未来的扩展需求。
API 命名规范
在 API 命名上，可以考虑以下规范：
- 使用英文单词命名，避免使用拼音或代码神秘命名
- 正确使用 HTTP 动词，如 GET、POST、PUT、DELETE 等
- 使用名词作为 API 的 URL，不要使用动词，如不要 /api/getUser ，而应该是 /api/user
- 使用复数形式，如 /api/users
- 对于子资源，我们可以使用这样的 URL：/api/users/:id/articles
示例代码：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- --- - --------- --------------------- ----- ---- -- - -- ------ -- ---------------------- ----- ---- -- - -- ----- -- ------------------------- ----- ---- -- - -- -------- -- ------------------------- ----- ---- -- - -- -------- -- ---------------------------- ----- ---- -- - -- ------ -- ---------------------------------- ----- ---- -- - -- -------- --
API 参数传递
在 API 参数传递上，可以考虑以下规范：
- 对于 URL 参数，可以使用
req.params的方式获取，例如/api/users/:id，则可以使用res.params.id获取 - 对于查询参数，可以使用
req.query获取，例如/api/users/search?name=xxx，则可以使用req.query.name获取 - 对于请求体，可以使用
req.body获取。
示例代码：
-- -------------------- ---- ------- ------------------------- ----- ---- -- - ----- -- - ------------- -- -- -- ------ -- --------------------- ----- ---- -- - ----- - ---- - - --------- -- -- ---- ------ -- ---------------------- ----- ---- -- - ----- - ----- --- - - -------- -- ----- --
API 错误处理
在 API 错误处理上，可以考虑以下规范：
- 在函数中对错误进行捕获，并返回错误信息
- 在全局定义错误处理中间件，统一处理错误信息。
示例代码：
-- -------------------- ---- -------
------------------------- ----- ---- ----- -- -
----- - -- - - ----------
-- ------
-- ------- -
----- ----- - --- ---------------
---------------- - ---
------ -----------
-
------ --------------------------
--
------------- ---- ---- ----- -- -
----- - ---------- - ---- ------- - - ---
-----------------------------
-------
--
--总结
一个高质量、易用、易于维护、遵循规范、安全可靠、错误处理合理的 API，对于前后端开发效率和质量的提升作用非常明显。在 Express.js 使用过程中，我们一定要注重 API 设计规范，遵循 RESTful 规范，以及考虑使用场景、易用性和未来的可扩展性，归纳总结出规范的 API 设计思路、命名规范、参数传递方式和错误处理机制。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64f8351ef6b2d6eab3057016