REST与RESTful

---

1.rest原则

(1)网络上的所有事物都被抽象为资源
(2)每个资源都有一个唯一的资源标识符
(3)同一个资源具有多种表现形式(xml,json等)
(4)对资源的各种操作不会改变资源标识符
(5)所有的操作都是无状态的
特点：
url简洁，将参数通过url传到服务器，而传统的url比较啰嗦，而且现实中浏览器地址栏会拼接一大串字符。但是采用REST的风格就会好很多，现在很多的网站已经采用这种风格了，这也是潮流方向，典型的就是url的短化转换。

2.关于restful

restful: 遵守了rest 原则 的web服务，可理解为REST式的web风格

3.请求相关设计方法

(1)域名：
应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

https://example.org/api/

(2)版本：
应该将API的版本号放入URL。

http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo

(3)路径：
对于一个简洁结构，应该始终用名词。 此外，利用的HTTP方法可以分离网址 中的资源名称的操作。

GET /products ：将返回所有产品清单
POST /products ：将产品新建到集合
GET /products/4 ：将获取产品 4
PUT /products/4 ：将更新产品 4

(4)http动词：
对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面四个（括号里是对应的SQL命令）。

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
DELETE（DELETE）：从服务器删除资源。

还有三个不常用的HTTP动词。

PATCH（UPDATE）：在服务器更新(更新)资源（客户端提供改变的属性）。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

(5)过滤信息:
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤 返回结果。
下面是一些常见的参数。

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

3.响应相关：
(1)状态码：
服务器向用户返回的状态码和提示信息，常见的有以下一些：

参数	描述
200 OK - [GET]	服务器成功返回用户请求的数据
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 - [*]	服务器发生错误，用户将无法判断发出的请求是否成功。

(2)错误处理：
如果状态码是4xx，服务器就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

(3)返回结果：
针对不同操作，服务器向用户返回的结果应该符合以下规范。

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

(4)超媒体：
RESTful API最好做到Hypermedia（即返回结果中提供链接，连向其他API方法），使得用户不查文档，也知道下一步应该做什么。
比如，Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。

{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}

从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

上面代码表示，服务器给出了提示信息，以及文档的网址。

(5)其他：
服务器返回的数据格式，应该尽量使用JSON，避免XML。