看Url就知道要什么 看http method就知道干什么 看http status code就知道结果如何

REST – REpreseantational State Transfer

@Ivony 老师的一句话很精辟： > URL定位资源，用HTTP动词（GET,POST,DELETE,DETC)描述操作

先说REST名称

REST – REpresentational State Transfer首先，之所以晦涩是因为前面主语被去掉了，全称是 Resource Representational State Transfer：通俗来讲就是：资源在网络中以某种表现形式进行状态转移。分解开来：Resource：资源，即数据（前面说过网络的核心）。比如 newsfeed，friends等；Representational：某种表现形式，比如用JSON，XML，JPEG等；State Transfer：状态变化。通过HTTP动词实现。

REST的出处

Roy Fielding的毕业论文。这哥们参与设计HTTP协议，也是Apache Web Server项目（可惜现在已经是 nginx 的天下）的co-founder。PhD的毕业学校是 UC Irvine，Irvine在加州，有着充裕的阳光和美丽的海滩，是著名的富人区。Oculus VR 的总部就坐落于此（虚拟现实眼镜，被FB收购，CTO为Quake和Doom的作者 John Carmack）。

论文地址

为什么要使用RESTful结构

大家都知道”古代”网页是前端后端融在一起的，比如之前的PHP，JSP等。在之前的桌面时代问题不大，但是近年来移动互联网的发展，各种类型的Client层出不穷，RESTful可以通过一套统一的接口为 Web，iOS和Android提供服务。另外对于广大平台来说，比如Facebook platform，微博开放平台，微信公共平台等，它们不需要有显式的前端，只需要一套提供服务的接口，于是RESTful更是它们最好的选择。在RESTful架构下：

Server的API如何设计才满足RESTful要求?

  1. URL root: https://example.org/api/v1/* https://api.example.com/v1/*

  2. API versioning: 可以放在URL里面，也可以用HTTP的header： /api/v1/

  3. URI使用名词而不是动词，且推荐用复数。

BAD

  • /getProducts
  • /listOrders
  • /retrieveClientByOrder?orderId=1

GOOD

  • GET /products : will return the list of all products
  • POST /products : will add a product to the collection
  • GET /products/4 : will retrieve product #4
  • PATCH/PUT /products/4 : will update product #4
  1. 保证 HEAD 和 GET 方法是安全的，不会对资源状态有所改变（污染）。比如严格杜绝如下情况：

GET /deleteProduct?id=1

  1. 资源的地址推荐用嵌套结构。比如： GET /friends/10375923/profile UPDATE /profile/primaryAddress/city

  2. 警惕返回结果的大小。如果过大，及时进行分页（pagination）或者加入限制（limit）。

HTTP协议支持分页（Pagination）操作，在Header中使用 Link 即可。

  1. 使用正确的HTTP Status Code表示访问状态：HTTP/1.1: Status Code Definitions

  2. 在返回结果用明确易懂的文本（String。注意返回的错误是要给人看的，避免用 1001 这种错误信息），而且适当地加入注释。

  3. 关于安全：自己的接口就用https，加上一个key做一次hash放在最后即可。考虑到国情，HTTPS在无线网络里不稳定，可以使用Application Level的加密手段把整个HTTP的payload加密。有兴趣的朋友可以用手机连上电脑的共享Wi-Fi，然后用Charles监听微信的网络请求（发照片或者刷朋友圈)。

各端的具体实现

如上面的图所示，Server统一提供一套RESTful API，web+ios+android作为同等公民调用API。各端发展到现在，都有一套比较成熟的框架来帮开发者事半功倍。

– Server – 推荐： Spring MVC 或者 Jersey 或者 Play Framework

– Android – 推荐： RetroFit 或者 Volley

– iOS – 推荐：RestKit ( RestKit/RestKit · GitHub )

– Web – 推荐随便搞！可以用重量级的AngularJS，也可以用轻量级 Backbone + jQuery 等。