RESTFUL_牛客博客

# 起源

参考：《理解RESTful架构》 - http://www.ruanyifeng.com/blog/2011/09/restful.html

REST这个词，是Roy Thomas Fielding在他2000年的博士论文《Architectural Styles and
the Design of Network-based Software Architectures》中提出的。

Fielding将他对互联网软件的架构原则，定名为REST，即 Representational State Transfer 的缩写。我对这个词组的翻译是"表现层状态转化"。

表现层（Representation）
“资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层”（Representation）。
资源（Resources）
REST的名称"表现层状态转化"中，省略了主语。“表现层"其实指的是"资源”（Resources）的"表现层"。
所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。
状态转化（State Transfer）
访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。
互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。
因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。
而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。

客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。
它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

# 设计

参考：http://www.ruanyifeng.com/blog/2014/05/restful_api.html

举个栗子

GET 	/zoos：列出所有动物园
POST 	/zoos：新建一个动物园
GET 	/zoos/ID：获取某个指定动物园的信息
PUT 	/zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH 	/zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE 	/zoos/ID：删除某个动物园
GET 	/zoos/ID/animals：列出某个指定动物园的所有动物
DELETE 	/zoos/ID/animals/ID：删除某个指定动物园的指定动物

# 过滤信息（Filtering）

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

# 状态码（Status Codes）

所有状态码：https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
幂等：https://developer.mozilla.org/zh-CN/docs/Glossary/%E5%B9%82%E7%AD%89

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 handling）

返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

# 返回结果

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