什么是restful风格API

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备……）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现API First的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。

协议

API与用户的通信协议，总是使用HTTPS协议

域名

应该尽量将API部署在专用域名之下，如何确定API很简单，不会有进一步扩展，可以考虑在主域名下

版本

应该将API的版本号放在URL中，另一个做法是，将版本号放在http头信息中，但不如放在url方便和直观

路径

路径又称为终点，代表了API的具体网址，每个网址代表一种资源，所以网址中不能有动词，只能有名词，而且所用的名词往往和数据库的表格名相互对应，一般来说，每个数据库中的表都是同种记录的集合，所以API中的名词也要使用复数

举个栗子：

#  有一个API提供商品信息
https://api.example.com/v1/goods
https://api.example.com/v1/categorys

HTTP动词

对于资源的具体操作类型， 由HTTP动词表示

GET(SELECT):从服务器中取出资源(一项或多项)
POST(CREATE):在服务器新建一个资源
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)
DELETE(DELETE):从服务器删除资源
HEAD:获取资源的元数据    
OPTIONS:获取信息，关于资源的哪些属性是客户端可以改变的

拿上边的商品信息举例子

GET /goods:列出所有商品
POST /goods:新建商品
GET /goods/ID:获取某个指定商品的信息
PUT /goods/ID:更新某个指定商品的信息(全部信息)
PATCH /goods/ID:更新某个商品的信息(部分信息)
DELETE /goods/ID:删除某个商品
GET /categorys/ID/good:列出商品类ID下所有商品
DELETE /categorys/ID/good/ID:删除某个指定商品类下的某个指定商品

过滤信息

如果记录数量很多，服务器不可能都将它们返回给用户，API应该提供参数，过滤返回结果

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /categorys/ID/goods 与 GET /goods?categorys_id=ID 的含义是相同的。

状态码

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
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 API最好做到面向文档，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么，比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。

{"link": {
  "rel":   "collection https://www.example.com/goods",
  "href":  "https://api.example.com/goods",
  "title": "List of goods",
  "type":  "application/vnd.yourformat+json"
{{

上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。

所以，API有四个级别，分别为：

level 0 ：面向过程，只是把HTTP当做一个传输的通道，没有把HTTP当做一种传输协议

level 1：面向资源，通过参数判断

level 2：面向标签，真正将HTTP作为了一种传输协议，最直观的一点就是Level2使用了HTTP动词，GET/PUT/POST/DELETE/PATCH....,这些都是HTTP的规范

level 3：面向文档,使用者只需要知道如何获取资源的入口，之后的每个URI都可以通过请求获得，无法获得就说明无法执行那个请求

所以，我们写API时，要朝着最高级别迈进，才能逐渐的成长起来