API 入门 (19) 分析 REST API

REST API 是 Web 应用开发中最常见的 API 风格. REST API 的风格要满足我们在上一篇文章中所提及的六个约束要求。这六个约束要求并没有严格规定 REST API 应该是什么样子,而是设计原则和指导。在不同的网络环境中,使用特定的通信协议,设计出来的 REST API 也不是完全相同的。

下面我们就研究一个在 Web 应用中,基于 HTTP 协议调用的 REST API.

HTTP 请求和响应

在线上购买自行车场景中,如果 API 的消费者想要获取一辆自行车的详细信息,该怎么办呢?API 的消费者必须向提供 API 的服务器发送一个请求:

GET /bikes/B007 HTTP/1.1
Accept: application/json, text/plain, */*
Host: lowtea.vip

很明显,这是一个 HTTP 请求。请求的内容做了简化,只保留了必要的内容。这一段请求的含义是:

  • GET - 表示 HTTP 的一个方法,常用的方法还有 POST,PUT,DELETE 等。
  • /bikes/B007 - 表示路径,标识出资源在服务器上的地址或位置。
  • Accept - 表示接受的响应数据的格式。
  • Host - 表示提供 API 的服务器。

在这里,GET /bikes/B007 就是 REST API 的表示。

再来看看响应:

HTTP/1.1 200 OK
{
    "bikeId": “B007”,
    "name": "一骑绝尘”,
    "price": “1999.00”,
    "brand": “NilBrand”
}

服务器响应的第一部分是 HTTP 的状态码(200)和原因(OK)。状态码表示请求处理的结果,原因是对结果的进一步说明。从返回的原因 OK,可以猜到,请求处理成功了。服务器响应的第二部分是响应体(response body),包含了请求路径所对应的资源内容,也就是我们的自行车信息。响应体是一个 JSON 格式的数据,包含了自行车的信息:编号,名称,价格和品牌。

REST API

接下来,我们把目标和 REST API 做一个映射,如下图:


目标与接口的映射

REST API 的消费者使用 HTTP 方法操作由路径标识的资源。/bikes/{bikeId} 既表示自行车目录中一辆自行车,也标识了一个服务器中的资源。HTTP 的 GET 方法表示检索动作,相对应的就是获取资源的操作。

小结

调用 REST API 与发送 HTTP 请求完全相同。最关键的就是方法/操作和路径/资源的映射。

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

推荐阅读更多精彩内容