在开发 API 时，如果不加版本控制，随着需求的改变或修复 Bug，很容易出现兼容性问题。因此，版本控制是 API 开发中的重要环节之一。本文将指导您如何使用 Express.js 实现 API 版本控制。
第一步：制定 API 版本控制策略
在实现 API 版本控制之前，要先确定策略。常见的策略有两种：
URL 前缀方式
采用 URL 前缀方式，每个版本的 API 都有不同的 URL 前缀。例如：
/api/v1/user /api/v2/user
优点是明确，易于管理和维护。缺点是 URL 会变得臃肿，不利于 SEO。
Header 版本标识方式
采用 Header 版本标识方式，客户端在请求 API 时通过 Header 传递版本号。例如：
GET /api/user HTTP/1.1 Accept-Version: 1.0.0
优点是 URL 简洁，不影响 SEO。缺点是代码实现稍微复杂一些。
根据实际情况选择适合自己的版本控制策略即可。
第二步：创建 Express.js 路由
在 Express.js 中创建多个路由，每个路由对应一个版本的 API。例如，我们要创建 v1 和 v2 两个版本的 user API，可以这样写：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- -- -- --- ----------------------- ----- ---- -- - ------------ ---- ------ --- -- -- --- ----------------------- ----- ---- -- - ------------ ---- ------ --- ---------------- -- -- ------------------- ------- -- ---- --------
这样就可以同时支持 v1 和 v2 两个版本的 user API 了。
第三步：实现版本控制
根据第一步选择的控制策略，编写版本控制中间件。
URL 前缀方式
如果采用 URL 前缀方式，可以使用 Express.js 的 router 参数，为每个路由添加版本前缀。例如：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- -------- - ----------------- ----- -------- - ----------------- --------------------- ----- ---- -- - ------------ ---- ------ --- --------------------- ----- ---- -- - ------------ ---- ------ --- ------------------ ---------- ------------------ ---------- ---------------- -- -- ------------------- ------- -- ---- --------
Header 版本标识方式
如果采用 Header 版本标识方式，可以编写一个版本控制中间件，解析请求 Header 中的版本号，然后交给对应版本的路由处理。例如：
-- -------------------- ---- -------
----- ------- - -------------------
----- --- - ----------
----- -------- - -----------------
----- -------- - -----------------
--------------------- ----- ---- -- -
------------ ---- ------
---
--------------------- ----- ---- -- -
------------ ---- ------
---
-------- ------------------- ---- ----- -
----- ------- - ------------------------------
-- -------- --- -------- -
-------------------- ----------
- ---- -- -------- --- -------- -
-------------------- ----------
- ---- -
--------------------------------- --- ----------
-
-
------------------------
---------------- -- -- ------------------- ------- -- ---- --------总结
通过以上步骤，我们可以在 Express.js 中实现 API 版本控制，根据实际情况选择版本控制策略，然后通过创建不同的路由或编写版本控制中间件实现版本控制。版本控制能够有效管理 API 版本，避免后期兼容性问题，是 API 开发过程中不可或缺的环节。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64d36aebb5eee0b525b099f6