RESTful 个人理解总结

ゝ一纸荒年。 2023-01-19 04:56 181阅读 0赞

### **一.什么是RESTful 面向资源** ###

简单的说：RESTful是一种架构的规范与约束、原则，符合这种规范的架构就是RESTful架构。

先看REST是什么意思，英文Representational state transfer 表述性状态转移 其实就是对 资源 的表述性状态转移。

（什么是表述性：就是指客户端请求一个资源，服务器拿到的这个资源，就是表述）

资源的地址 在web中就是URL （统一资源标识符）

资源是REST系统的核心概念。 所有的设计都是以资源为中心

结合项目怎么识别资源

1.商品加入购物车 购物车

2.提交订单 订单

3.创建用户 用户

围绕资源进行 添加，获取，修改，删除，以及对符合特定条件的资源进行列表操作 。针对资源设计接口

### **二.关于规范与约束有哪些？** ###

RESTful 架构的核心规范与约束：统一接口

分为四个子约束：

1.每个资源都拥有一个资源标识，每个资源的资源标识可以用来唯一地标明该资源

2.消息的自描述性

3.资源的自描述性。

4.HATEOAS Hypermedia As The Engine Of Application State(超媒体作为应用状态引擎)

即客户只可以通过服务端所返回各结果中所包含的信息来得到下一步操作所需要的信息，如到底是向哪个URL发送请求等。也就是说，一个典型的REST服务不需要额外的文档标示通过哪些URL访问特定类型的资源，而是通过服务端返回的响应来标示到底能在该资源上执行什么样的操作

目的：实现客户端无需借助任何文档即能调用到所有的服务器资源

![7d6e3d106ed24b8610b138a82254103e.png][]

### **三、资源的URL设计** ###

**1.通过URL来表示资源**

资源分为主资源与子资源

因为主资源是一类独立的资源 所以主资源应直接放在相对路径下：例如

若要表示主资源的实例：如果实例的ID=1，则这样表示： /goods/1

子资源：

一个实例的子资源可能是一个集合也可能是一个单一的子资源

子资源为图片集合：/goods/1/pictures

子资源为商品折扣的单子子资源：/goods/1/discount

**2.单数 vs. 复数**

获取用户1的信息，哪种方式更符合RESTful?

/api/users/1

/api/user/1

**3.相对路径 vs. 请求参数**

极光的RESTful API:

获取用户信息 GET /v1/users/\{username\} 参数放在路径中

获取用户信息 GET /v1/users?username=xxxxx 拼接的方式

获取应用管理员列表 GET /v1/admins?start=\{start\}&count=\{count\} ？后拼接参数的方式：这种方式一般作为过滤资源

**4.使用合适的动词 get delete put post**

选择请求接口的方式： get delete

PUT 在服务器更新资源（客户端提供改变后的完整资源）。

POST 在服务器新建一个资源

**5.使用标准的状态码**

## GET ##

*  安全且幂等
 *  获取表示
 *  变更时获取表示（缓存）

*  200（OK） - 表示已在响应中发出

*  204（无内容） - 资源有空表示
 *  301（Moved Permanently） - 资源的URI已被更新
 *  303（See Other） - 其他（如，负载均衡）
 *  304（not modified）- 资源未更改（缓存）
 *  400 （bad request）- 指代坏请求（如，参数错误）
 *  404 （not found）- 资源不存在
 *  406 （not acceptable）- 服务端不支持所需表示
 *  500 （internal server error）- 通用错误响应
 *  503 （Service Unavailable）- 服务端当前无法处理请求
 *  ## POST ##
    
     *  不安全且不幂等
     *  使用服务端管理的（自动产生）的实例号创建资源
     *  创建子资源
     *  部分更新资源
     *  如果没有被修改，则不过更新资源（乐观锁）
    
     *  200（OK）- 如果现有资源已被更改
    
     *  201（created）- 如果新资源被创建
     *  202（accepted）- 已接受处理请求但尚未完成（异步处理）
     *  301（Moved Permanently）- 资源的URI被更新
     *  303（See Other）- 其他（如，负载均衡）
     *  400（bad request）- 指代坏请求
     *  404 （not found）- 资源不存在
     *  406 （not acceptable）- 服务端不支持所需表示
     *  409 （conflict）- 通用冲突
     *  412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）
     *  415 （unsupported media type）- 接受到的表示不受支持
     *  500 （internal server error）- 通用错误响应
     *  503 （Service Unavailable）- 服务当前无法处理请求
    
    ## PUT ##
    
     *  不安全但幂等
     *  用客户端管理的实例号创建一个资源
     *  通过替换的方式更新资源
     *  如果未被修改，则更新资源（乐观锁）
    
     *  200 （OK）- 如果已存在资源被更改
    
     *  201 （created）- 如果新资源被创建
     *  301（Moved Permanently）- 资源的URI已更改
     *  303 （See Other）- 其他（如，负载均衡）
     *  400 （bad request）- 指代坏请求
     *  404 （not found）- 资源不存在
     *  406 （not acceptable）- 服务端不支持所需表示
     *  409 （conflict）- 通用冲突
     *  412 （Precondition Failed）- 前置条件失败（如执行条件更新时的冲突）
     *  415 （unsupported media type）- 接受到的表示不受支持
     *  500 （internal server error）- 通用错误响应
     *  503 （Service Unavailable）- 服务当前无法处理请求
    
    ## DELETE ##
    
     *  不安全但幂等
     *  删除资源
    
     *  200 （OK）- 资源已被删除
    
     *  301 （Moved Permanently）- 资源的URI已更改
     *  303 （See Other）- 其他，如负载均衡
     *  400 （bad request）- 指代坏请求
     *  404 （not found）- 资源不存在
     *  409 （conflict）- 通用冲突
     *  500 （internal server error）- 通用错误响应
     *  503 （Service Unavailable）- 服务端当前无法处理请求
 *  **6.选择适当的表示结构**
    
    json xml
    
    **7. 版本控制**
    
    例如：![45a3c0c35e18b8f2e62e61b7c633e3a9.png][]

hello world!!!

![20210508103317465.jpeg][]

[7d6e3d106ed24b8610b138a82254103e.png]: /images/20221021/ae786fcac4ee4d16a162ae0d58a1091e.png
[45a3c0c35e18b8f2e62e61b7c633e3a9.png]: /images/20221021/58415aeaede5492db615feea57a4a333.png
[20210508103317465.jpeg]: /images/20221021/c1bfbbfc40e7486b9b74cf690ab3f673.png