[设计篇]01.RESTFUL URI 简单入门设计

1. HTTP Methods

HTTP 常用方法：

• GET: 获取某个资源。
• POST: 创建一个新的资源。
• PUT: 替换某个已有的资源。
• PATCH: 修改某个已有的资源。-->这个自己没有怎么使用过
• DELETE：删除某个资源。

我原先以为修改某一个资源，也是用 POST，后来发现还有一个 PATCH，但发现 HttpClient 并没有提供此调用方法，需要我们进行扩展

2. JSON API 命名规则[摘录]

camelCase（骆驼命名）我们都非常熟悉，因为 C# 就是使用的这个命名法，snake_case（蛇形命名）适用于 python 和 ruby，比如商品 ID，camelCase 会命名为 productId，snake_case 则会命名为 product_id。

需要注意的是，snake_case 只限于 JSON API 命名，并不限于 URI，URI 中一般也不会使用下划线，为什么要对 JSON API 进行规范命名？因为 RESTful 是无状态风格，也就是说 RESTful API 并不限于某一种客户端进行调用，所以 JSON API 的命名必须要规范，如果只是 C# 调用的话，那么命名采用 camelCase 命名就可以了，但显然并不是这样，最后得出的结论是使用 snake_case 命名会比较好，以后在设计的时候，需要注意了。

3. API URI  DESIGN[重点]

API URI 设计最重要的一个原则：nouns (not verbs!)，名词（而不是动词）。

CRUD 简单 URI设计：

• GET /users/list - 获取用户列表--->这里是我自己修改的
• GET /users/1 - 获取 Id 为 1 的用户
• GET /users - 跳转到用户添加页面
• POST /users - 创建一个用户
• PUT /users/1 - 替换 Id 为 1 的用户
• PATCH /users/1 - 修改 Id 为 1 的用户
• DELETE /users/1 - 删除 Id 为 1 的用户

这里我多少有点疑问，关于如何使用还是有点商榷!

整体上思路有点混乱，如果有更好的简易方式，我们在一起商量！可以留言就行设计！

上面是对某一种资源进行操作的 URI，那如果是有关联的资源，或者称为级联的资源，该如何设计 URI 呢？比如某一用户下的产品：

• GET /users/1/products - 获取 Id 为 1 用户下的产品列表
• GET /users/1/products/2 - 获取 Id 为 1 用户下 Id 为 2 的产品
• POST /users/1/products - 在 Id 为 1 用户下，创建一个产品
• PUT /users/1/products/2 - 在 Id 为 1 用户下，替换 Id 为 2 的产品
• PATCH /users/1/products.2 - 修改 Id 为 1 的用户下 Id 为 2 的产品
• DELETE /users/1/products/2 - 删除 Id 为 1 的用户下 Id 为 2 的产品