最近开发学习中用到了REST API,处于懵懂,此REST,非彼rest,不是我们理解的含义,这是一种缩写,REpresentational State Transfer,再具体一些就是Resource Representational State Transfer,直译还是不懂,看着三个单词,
Resource:资源,即数据,比如 newsfeed,friends等; Representational:某种表现形式,比如用JSON,XML,JPEG等; State Transfer:状态变化,通过HTTP动词实现;
知乎的Ivony老师总结了一句,看起来有些感觉,
URL定位资源,用HTTP动词(GET,POST,DELETE,DETC)描述操作。
REST的出处来自于Roy Fielding的毕业论文《Architectural Styles and the Design of Network-based Software Architectures》,这人超牛,学历牛技术牛,有兴趣可以google下,论文可以下载,http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm,论文第五章则提到了REST,《Representational State Transfer (REST)》,
学习REST,必须动手实践,用起来才能慢慢体会,否则只能停留于理论,但是基础的理论学习,还是必须,我主要是参考了,阮一峰老师的《RESTful API 设计指南》,概括精辟,没有任何废话,总结引用于此,亦可以原文学习,
http://www.ruanyifeng.com/blog/2014/05/restful_api.html
API与用户的通信协议,总是使用HTTPs协议。 应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。 https://example.org/api/ 应该将API的版本号放入URL。 https://api.example.com/v1/ 版本号放在HTTP头信息中,不如放入URL方便和直观。 服务器返回的数据格式,应该尽量使用JSON,避免使用XML。 路径又称"终点"(endpoint),表示API的具体网址。在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。 例如API提供动物园(zoo)的信息,包括各种动物和雇员的信息,则它的路径应该设计成下面这样。
HTTP动词和过滤信息 对于资源的具体操作类型,由HTTP动词表示。常用的HTTP动词有下面五个(括号里是对应的SQL命令)。
还有两个不常用的HTTP动词。
例如
如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。 例如
参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复,例如,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。 状态码(Status Codes) 服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。
状态码的完全列表参见 https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html 如果状态码是4xx,就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。 {error: "Invalid API key"} 针对不同操作,服务器向用户返回的结果应该符合以下规范。
通过以上基础理论的了解,对于REST,可能会有一个感性的认识,对于任何一门技术来说,实践都是最重要的方法,动起手来,体会一下,理解就会不同,欢迎朋友们互相交流。