什么是REST API

REST 全称Representational State Transfer, 阮一峰翻译为“表现层状态转化”理解RESTful架构,维基百科“具象状态传输”。
它描述了一个系统如何与另一个交流。比如一个产品的状态(名字,详情)表现为XML,JSON或者普通文本。

REST 有六个约束:

  • 统一的接口
    • 统一的接口约束定义客户端和服务器之间的接口。它简化并且解耦架构,让每个部分独立发展。统一接口的四项指导原则是:
    • 基于资源的(Resource-Based)
      各个资源使用URI作为资源标识符表示的请求。资源本身概念性的从被返回的客户端的表现层分开。比如:服务器不发送它的数据库,而是一些HTML,XML或者JSON代表数据库记录表现。比如,在Finnish和UTF-8编码,取决于请求的细节和服务器的实现。
    • 通过表现层操作资源(Manipulation of Resources Through Representations)
      当客户端持有一个资源的表现,包含附加的元数据,它就有足够的信息区修改或者删除资源如果服务器有提供权限
    • 自我描述消息(Self-descriptive Message)

每个消息包含了足够的信息描述如何处理消息。比如,使用哪个解析器调用可能被指定的Internet媒体类型。返回页明确的指定它们的缓存能力
* 超媒体作为应用状态的引擎(Hypermedia as the Engine of Application State (HATEOAS))
客户端通过body内容,query-string参数,请求头(request-headers)和请求URI(resource name)传递状态。服务器通过body内容,返回码(response codes)和返回头(response headers)传递状态。这在技术上成为对超媒体(或超文本来的超链接)
出了上述说明,HATEOS也意味着,在必要时,链接被包含在返回体(body)或者头(headers)去检索对象本身或者相关的对象提供URI。

  • 无状态的(stateless)
    知道REST是Representational State Transfer的缩写,无状态是关键。
  • 可缓存的(Cacheable)
  • 客户端-服务器(Client-Server)
  • 分层系统(Layered System)
  • 按需代码(可选)

REST是设计风格而不是标准。

RESTful架构:

  • 每一个URI代表一种资源
  • 客户端和服务器之间,传递这种资源的某种表现层;
  • 客户端通过几个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。
    动词分别是
  • GET:用来获取资源,GET操作应该是幂等(idempotence)的,且无副作用
  • POST:用于新建资源(也可用于修改资源)
  • PUT:替换某个已有的资源。PUT操作虽然有副作用,但其应该是幂等的。
  • DELETE:用于删除资源。DELETE操作有副作用,但也是幂等的。
  • PATCH(RFC5789) :修改某个已有的资源

幂等:相同的数据和参数下,执行一次或多次产生的效果(副作用)是一致性的。

对于REST API来说,有一些HTTP headers很重要:

  • Accept:服务器需要返回什么样的content。如果客户端要求返回"application/xml",服务器端只能返回"application/json",那么最好返回status code 406 not acceptable(RFC2616),当然,返回application/json也并不违背RFC的定义。一个合格的REST API需要根据Accept头来灵活返回合适的数据。
  • If-Modified-Since/If-None-Match:如果客户端提供某个条件,那么当这个条件满足时,才返回数据,否则返回304 not modified。如果客户端已经缓存了某个数据,它只想看看有没有新的数据时,会用这两个header之一,服务器如果不理睬,依旧返回200 ok的话,就显得不专业也不高效。
  • If-Match:在对某个资源做PUT/PATCH/DELETE操作时,服务器应该要求客户端提供If-Match头,只有客户端提供的Etag与服务器对应资源的Etag一致,才进行操作,否则返回412 precondition failed。

Status code
返回的status code也应该规范,可参考clojure下的liberator

转载自微信公众号:程序人生

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • API定义规范 本规范设计基于如下使用场景: 请求频率不是非常高:如果产品的使用周期内请求频率非常高,建议使用双通...
    有涯逐无涯阅读 2,517评论 0 6
  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 3,408评论 0 19
  • 今日推荐文章:《What is a REST API》 来源quora 的最高得票回复 推荐阅读时间10分钟 往期...
    饥人谷_若愚阅读 882评论 1 4
  • 就在雨中, 就在我的伞外, 这么近, 这样触目, 我想,不是你,不是我, 而是你我,都会欢喜怜爱。 很想,问问花的...
    二林壹木阅读 206评论 0 0