RESTful架构初探

RESTful架构是目前较为流行的一种互联网软件架构，最早由Roy Thomas Fielding在他2000年的博士论文中提出，它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。

RESTful架构通常包含以下设计规则：

• Endpoint（终点，即API的具体网址）

在RESTful架构中，每个网址代表一种资源，网址中不允许出现动词，只能有名词，所用的名词常与数据库表的字段相对应，一般而言，数据库表都是同种记录的集合，所以API中的名词应该使用复数。动作使用HTTP动词来表达。

• HTTP动词

常用的HTTP动词有如下几种

GET（SELECT）：用于从服务器查询资源（一项或多项）。
POST（CREATE）：用于在服务器创建资源。
PUT（UPDATE）：用于在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：用于在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：用于从服务器删除资源。

• 状态码

常见的状态码定义如下，完整版参见https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html。

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

• 错误处理

如果有报错信息，应该向用户返回出错信息，一般而言，返回信息中将error作为键名，出错信息作为键值。

{
    "error": "cannot match zonename Dev"
}

• 返回结果

服务器向用户返回结果应符合以下规范：

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

---待补充