RESTFul API

推荐RESTFul API调试插件工具

Chrome：Postman/Advanced Rest Client

Firefox：RESTClient

一、协议

API与用户的通信协议，总是使用Https协议

二、域名

应该尽量将API部署在专用域名之下

https://api.example.com

三、版本

应该将API的版本号放入URL中

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

四、路径

路径又称为“终点”，表示API的具体网址。

在RESTFul架构中，每个网址代表一种资源，所以网址中不能有动词，只能有名词。

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

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

五、HTTP动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面五个（括号里是对应的SQL命令）

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

还有两个不常用的HTTP动词

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

六、过滤信息（Filtering）

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

七、状态码（Status Codes）

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

八、错误处理

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

{
    "error": "Invalid API key"
}

九、返回结果

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

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

十、Hypermedia API

RESTFul API最好做到Hypermedia API，即返回结果中提供链接，连向其他API方法，使得用户不差文档，也知道下一步应该做什么。GitHub的API就是这种设计，访问https://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"
}

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

十一、其他

（1）API的身份认证应该使用OAuth 2.0框架

（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML

本文参考：

RESTful API 设计指南（阮一峰）