RESTful接口入门

RESTful产生背景

从下面的图片可以看出，当我们需要把相同的数据展示到不同的界面上时，提供一个可以访问后台的接口，前台只负责将数据友好的，华丽的展示出来即可。而不需要为每一个前台都实现很多的后台逻辑。
RESTful用途

设计方法

协议

Web协议，自然用HTTP，但是现在都用安全的HTTPS协议

域名

专门的服务，专门的域名。（这个更适合互联网公司，有Android，iOS，Web浏览器，为一个专门的服务提供一个专门的域名显然更合适）

版本

考虑到兼容之前发布的版本，为每个版本提供不同的数据来源。

https://api.example.com/v1/

路径

表示API的具体网址。
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的”集合”（collection），所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

1https://api.example.com/v1/zoos
2https://api.example.com/v1/animals
3https://api.example.com/v1/employees

HTTP动词

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

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

两个不常用的动词

1HEAD：获取资源的元数据。
2OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

举例：

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

过滤信息（Filtering）

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

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

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

状态码（Status Codes）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

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

错误处理（Error handling）

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

1{
2    error: "Invalid API key"
3}

返回结果

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

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

服务器返回的数据格式，应该尽量使用JSON，某些场合非XML不可时再使用XML。

使用方法

由于RESTful接口返回的都是json格式的数据，做好对这些json处理即可。

参考资料：
https://www.zhihu.com/question/28557115/answer/48094438
http://www.ruanyifeng.com/blog/2014/05/restful_api.html