RESTful API简介

本文主要参考自《RESTful API 设计指南》。

现在的网站没有API都给人落后的印象了，而当下设计API流行的规范便是RESTful。它涉及到以下这些内容。

域名

应尽量部署在专用域名之下，可以在前边加个二级头或者域名后添加api路径。

https://api.example.com
https://example.com/api/

版本

API经常会变，因此要注意区分版本。一般放入URL中。

https://api.example.com/v1/

路径

路径又称”终点”（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）：从服务器删除资源

下面是一些例子。

• 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：指定筛选条件

状态码

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 – [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的
• 405  method not allowed – [*]：该http方法不被允许
• 406 Not Acceptable – [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）
• 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的
• 422 Unprocesable entity – [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误
• 500 INTERNAL SERVER ERROR – [*]：服务器发生错误，用户将无法判断发出的请求是否成功

错误处理

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

{error: "invalid API key"}

返回结果

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

• GET /collection：返回资源对象的列表（数组）
• GET /collection/resource：返回单个资源对象
• POST /collection：返回新生成的资源对象
• PUT /collection/resource：返回完整的资源对象
• PATCH /collection/resource：返回完整的资源对象
• DELETE /collection/resource：返回一个空文档

以上即为阮兄文章的主要内容。不得不说阮兄的文章通俗易懂，干净利落，赞一个！

在实际开发当中，如果要展示一个添加数据的表单，什么样的路由才是符合RESTful规范的？不知道大家有没有过这样的想法，我就有过。其实，RESTful规范主要是规范API设计的，展示一个表单，这个压根就不是API，而用用户交互界面，这里边就没有RESTful什么事了。怎么设计爽就怎么来就得了，不必过度为了规范而规范，实际上当前网站的路由基本是没有什么规范可言的。

另外，浏览器表单一般就支持GET和POST，没有PUT、DELETE之类的，要如何解决？一般做法是添加一个隐藏域，name为_method，明确指定为PUT或者DELETE之类。其他客户端一般都是支持PUT、DELETE这些的。Ajax也支持的（部分浏览器）。

参考链接：http://www.ruanyifeng.com/blog/2014/05/restful_api.html