随着 web 技术的发展，越来越多的 web 应用采用了 RESTful 架构风格。URL 是 RESTful API 中最重要的设计之一，它作为资源的唯一标识符，不仅需要与 HTTP 动词进行分离，还需要符合 RESTful 风格的一些约定和规范。在本文中，我们将介绍一些 URL 设计的指南，以便您为自己的 RESTful API 设计一个合理的 URL。
1. 使用名词而非动词
RESTful API 的设计理念是将 web 应用程序转换成资源，每个资源都有自己的 URL 地址。在 URL 的设计中，应该使用名词而非动词来表示该资源。例如，一个订单资源应该使用 /orders，而不是 /create_order 或 /get_orders。
// 获取订单列表 GET /orders // 创建新订单 POST /orders
2. 使用恰当的 HTTP 方法
当我们用名词表示资源时，就需要使用 HTTP 方法（GET、POST、PUT、DELETE 等）来对资源进行操作。 在 RESTful API 设计中，使用 HTTP 方法的规则如下：
- GET 用于获取资源；
- POST 用于创建资源；
- PUT 用于更新资源；
- DELETE 用于删除资源。
// 获取指定订单信息 GET /orders/:id // 更新指定订单信息 PUT /orders/:id // 删除指定订单 DELETE /orders/:id
3. 通过路径来表示资源之间的关联
有时候，资源之间有关联，例如，一篇文章可能有多个标签，一个标签也可以对应多篇文章。在这种情况下，我们可以使用 URL 路径来表示资源之间的关联。
// 获取所有标签 GET /tags // 获取指定标签的文章列表 GET /tags/:tag_id/posts // 获取指定文章的标签列表 GET /posts/:post_id/tags
4. 使用单数和复数形式
当我们在 URL 中表示资源时，要注意使用单数还是复数的形式。一般来说，对于表示一个集合的资源，我们使用复数形式，对于表示一个实体的资源，我们使用单数形式。
-- -------------------- ---- ------- -- -------- --- ------- -- -------- --- ----------- -- ------ --- ----- -- -------- --- ---------
5. 使用连字符而非下划线
在 URL 的设计中，我们应该使用连字符（-），而不是下划线（_）。这是因为连字符在 URL 中更为常见，也更易读。
// 获取指定文章的评论列表 GET /posts/:post_id/comments // 获取指定商品的评论列表 GET /products/:product_id/comments
6. 遵循嵌套层级结构
在某些情况下，我们需要表示的资源具有嵌套关系。例如，一篇文章可能有多个评论，一个评论也可以对应多篇文章。在这种情况下，我们可以使用嵌套的 URL 路径来表示这种关系。
// 获取指定文章的评论列表 GET /posts/:post_id/comments // 获取指定评论的回复列表 GET /comments/:comment_id/replies
结论
本文介绍了一些 RESTful API 中 URL 设计的指南，包括使用名词而非动词、使用恰当的 HTTP 方法、通过路径来表示资源之间的关联、使用单数和复数形式、使用连字符而非下划线以及遵循嵌套层级结构。通过遵循这些指南，可以创建出简洁、易读、易维护的 RESTful API，为 web 应用程序的开发提供更好的基础设施。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67038733d91dce0dc84ba495