在开发 Web 应用程序时，RESTful API 经常被用来实现服务器端和客户端的通信。RESTful API 是一种基于 HTTP 协议的 Web 服务，设计原则是通过 URL 和 HTTP 方法来定义资源，从而实现对它们的 CRUD（Create，Read，Update 和 Delete）操作。
路由是指请求的 URL 对应着服务器上的某个处理程序。在 RESTful API 中，路由设计是一个重要的话题，其中许多细节决定了 API 的实用性和可维护性。本文将分享三种常用的 RESTful API 路由设计方法，帮助开发者合理地组织代码和处理请求。
1. 路径内置参数
在 RESTful API 中，路径参数通常用于在 URL 中传递变量信息，例如：/users/:id。这种设计的优势在于，每个资源都是唯一的，可以通过一个标识符来访问。但是在资源拥有多个属性时，只使用路径参数无法满足需求。
因此，我们可以使用“路径内置参数”的方法，该方法允许将其他参数嵌入到请求 URL 的路径中，通常使用{变量名}的格式。例如：/users/{id}/orders/{order_id}。
通过这种方式设计的路由，可以支持多个参数的处理，同时还能保持 URL 的清晰度和易读性。下面是一个示例代码：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- --- - --------- -- -------- ---------------------------- ----- ---- -- - ----- ------ - ------------- -- --- -- -- -------- -------------------------------------- ----- ---- -- - ----- ------ - ------------- ----- ------- - ------------------- -- --- -- -- ------ ----------------------------------------- ----- ---- -- - ----- ------ - ------------- ----- ------- - ------------------- -- --- --
2. 使用查询字符串
查询字符串是一个问号（？）后的键值对，例如：/users?id=123。它可以用于查询和筛选服务端的数据。通常用于过滤和排序等操作。
使用查询字符串的优势在于，可以处理不同属性和多个可选参数。然而，这种方法不如路径参数可读性好，并且会增加请求 URL 的长度，可能会对性能产生一定影响。
下面是一个查询参数的示例代码：
-- -------------------- ---- ------- -- -------- ------------------------ ----- ---- -- - ----- ------ - ------------ ----- ------ - ---------------- -- --- -- -- -------- ---------------------------- ----- ---- -- - ----- ------- - ------------- -- --- -- -- ------ ------------------------------- ----- ---- -- - ----- ------- - ------------- -- --- --
3. 动词 + 路径
在 RESTful API 中，HTTP 方法也很重要。每个请求都应该具有正确的 HTTP 方法，例如 GET、POST、PUT 和 DELETE，分别对应 CRUD 操作。与此同时，路径也应该能够反映出所执行的行为。
例如，对于用户实体，我们可以使用以下示例说明：
-- -------------------- ---- ------- -- ------ ----------------- ----- ---- -- - -- --- -- -- ----- ------------------ ----- ---- -- - -- --- -- -- ------ --------------------- ----- ---- -- - ----- ------ - ------------- -- --- -- -- ------ --------------------- ----- ---- -- - ----- ------ - ------------- -- --- -- -- ------ ------------------------ ----- ---- -- - ----- ------ - ------------- -- --- --
这种方法很容易理解，因为 HTTP 方法通常反映出所执行的操作。但是，如果我们的资源表达有更复杂的操作，则此方法可能不够灵活。
总结
三种 RESTful API 路由设计方法中的每一种都有其优点和局限性。在设计 API 时，开发者应根据具体情况选择最优路由设计，并侧重于可读性、性能和可维护性。我们可以根据具体业务场景，灵活使用这三种方式。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64c396c083d39b488178fa7d