ITPub博客

REST初体验

原创 作者:bisal 时间:2018-05-06 10:47:07 0 删除 编辑

最近开发学习中用到了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)的信息,包括各种动物和雇员的信息,则它的路径应该设计成下面这样。

  • 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:获取信息,关于资源的哪些属性是客户端可以改变的。

例如

  • GET /zoos:列出所有动物园

  • POST /zoos:新建一个动物园

  • GET /zoos/ID:获取某个指定动物园的信息

  • PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)

  • PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)

  • DELETE /zoos/ID:删除某个动物园

  • GET /zoos/ID/animals:列出某个指定动物园的所有动物

  • DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

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

例如

  • ?limit=10:指定返回记录的数量

  • ?offset=10:指定返回记录的开始位置。

  • ?page=2&per_page=100:指定第几页,以及每页的记录数。

  • ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。

  • ?animal_type_id=1:指定筛选条件

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


状态码(Status Codes)

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

  • 200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。

  • 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格式)。

  • 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

状态码的完全列表参见

https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

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

{error: "Invalid API key"}

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

  • GET /collection:返回资源对象的列表(数组)

  • GET /collection/resource:返回单个资源对象

  • POST /collection:返回新生成的资源对象

  • PUT /collection/resource:返回完整的资源对象

  • PATCH /collection/resource:返回完整的资源对象

  • DELETE /collection/resource:返回一个空文档


通过以上基础理论的了解,对于REST,可能会有一个感性的认识,对于任何一门技术来说,实践都是最重要的方法,动起手来,体会一下,理解就会不同,欢迎朋友们互相交流。



如果您觉得此篇文章对您有帮助,欢迎关注微信公众号:bisal的个人杂货铺,您的支持是对我最大的鼓励!共同学习,共同进步:)

请登录后发表评论 登录
全部评论
10g/11g OCP,11g OCM,YEP成员(Oracle Young Expert Program,Oracle用户组年轻专家项目),EXIN DevOps Master,我不是DBA,但我的爱好是Oracle,微信公众号:bisal的个人杂货铺

注册时间:2013-07-26

  • 博文量
    320
  • 访问量
    2600829