一、简介
网络应用程序，分为前端和后端两个部分。当前的发展趋势下，前端设备层出不穷。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。
今天，我简单介绍RESTful API的设计细节，共同探讨如何设计一套合理、好用的API。当不理解REST时可以先尝试去使用它，慢慢的你会发现他是如此的好用。
二、概念：
在RESTful架构中，每个网址代表一种资源（resource），而资源则是通过url暴露。所有网址请求接口中不能有动词，只能有名词,这点和数据库设计风格很像。 URI 的设计只要负责把资源通过合理方式暴露出来就可以了。对资源的操作与它无关，操作是通过 HTTP动词来体现，所以REST 通过 URI 暴露资源时，会强调不要在 URI 中出现动词。
三、入门
1、协议 ：API与用户的通信协议，目前使用最多的为HTTP协议。
2、域名：应尽量将API部署的专用的域名之下，若API相对复杂最好不要直接使用主域名。
3、版本：应将API版本放在URL中，当然还有另一种做法，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github目前采用的就是这种做法。
4、路径：路径又称"地址"，表示API的具体网址。在REST架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。
举例来说：有一个API提供人员（user）的信息 - > https://api.example.com/v1/users。
四、基础
1、HTTP动词：对于传统的API来说仅仅把HTTP做为传输通道，对URL的命名及使用较为混乱，而REST对于资源的具体操作类型，由HTTP动词表示（前五项为常用的动词），规范的这一过程。
GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
2、过滤信息：如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果，和传统的API类似。下面介绍两个常见的参数。
?page=2&imit=10：指定第几页，以及每页的记录数。
?field=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
3、状态码：服务器向用户返回的状态信息，状态码的完全列表参见状态码。
4、错误处理：如果状态码是4XX，一般来说就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。例如：{error:"Invalid API key"}
5、返回结果：针对不同操作，服务器向用户返回的结果应该符合以下规范。
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
五、进阶
1、HATEOAS（Hypertext As The Engine Of Application State）
ESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下 一步应该做什么。比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。
{"link": {"rel":"collectionhttps://www.example.com/users","href":"https://api.example.com/ users","title":"List of users","type":"application/vnd.yourformat+json" } }
上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当 前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。
Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表,具体可根据自己的需求设计。
参考资料：RESTful API 设计指南
