RESTful架构是一种流行的互联网软件架构,它结构清晰,符合标准,易于理解,扩展方便。 REST是Representational State Transfer的缩写,翻译为“表现层状态转化”。表现层其实就是资源,因此可以理解为“资源状态转化”。 网络应用上的任何实体都可以看作是一种资源,通过一个URI(统一资源定位符)指向它。
“资源”是一种信息实体,它可以有多种外在表现形式。我们把“资源”具体呈现出来的形式叫做它的“表现层”。 例如,文本可以是txt格式表现,也可以用HTML格式,XML格式,JSON格式表现;图片可以是JPG格式也可以是PNG格式表现等。
URI之代表资源实体,不代表它的形式。URI应该之代表“资源”的位置,而它具体的表现形式应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对“表现层”的描述。
访问一个WEB应用就代表了客户端与服务短的一个互动过程。HTTP协议是一个无状态协议。因此所有的状态都保存在服务端。如果客户端想要操作服务器,就必须通过某种手段让服务端发生“状态变化”(State Transfer)。而这种状化是建立在表现层之上的,所以就是“表现层状态转化”。
API与用户的通信协议,总是使用HTTPs协议
应该尽量将API部署在专用域名之下。
如果确定API很简单,不会用进一步扩展,则可以考虑放在主域名下
应该将API的版本号放入URI
也可以放在HTTP头信息中,但不如仿如URI直观
路径就是API的网址,每一个路径代表一种资源,所以路径只有名词不能有动词。而且所用的名词往往与数据库表名对应。一般而言,数据库中的表是记录的集合,因此API中的名词也应该使用复数。例如:
https://api.example.com/v1/zoos https://api.example.com/v1/animals
对于资源的具体操作,由HTTP动词表示 常用的HTTP动词包括一下几个,括号里是对应的SQL命令:
还有两个不常用的HTTP动词
下面是若干例子:
如果记录数过多,服务器不可能一次性将所有的信息返回给客户端。API应该提供参数,过滤返回结果。下面一些常见的参数:
参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)
状态码的完整列表参见这里
如果状态码是4XX,就应该向客户端返回出错信息。一般来说,返回的信息中将error作为键名。
{ error: "Invalid API key" }
针对不同的操作,服务器想客户端返回的结果应该符合一下规范
RESTful API最好做到Hypermedia,即返回结果中提供链接,指向其他API方法,是的用户不查文档,也知道该怎么做。比如,当用户向api.example.com的根目录发出请求,会得到这样一个文档:
{"link": { "rel": "collection https://www.example.com/zoos", "href": "https://api.example.com/zoos", "title": "List of zoos", "type": "application/vnd.yourformat+json" }}
上面代码表示,文档中有一个link属性,用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系(collection关系,并给出该collection的网址),href表示API的路径,title表示API的标题,type表示返回类型
Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表
{ "current_user_url": "https://api.github.com/user", "authorizations_url": "https://api.github.com/authorizations", // ... }