RESTful API

什么是RESTful API ?

REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”或“表现层状态转化”。

什么是URI和URL?

URI统一的资源标志符
URL统一的资源定位符
URI是给我们的资源进行标识的，URL是描述我们资源地址的。

REST风格的特点:

1. 在web中,只要有被引用的必要都叫资源.

2.每个URI代表一个资源,独一无二的.

3. 客户端通过HTTP的方法,对服务器端的资源进行操作.

4. 客户端和服务器之间,传递这种资源的某种表层.

5. 通过超链接的指引,实现"表现层转态转移".

RESTFUL规范

面向资源编程

每个URL代表一种资源,URL中尽量不要用动词,要用名词.

根据methond不同,进行不同的操作

GET  : 从一个服务器取出资源(一项或多项)
POST : 从一个服务器新建一个资源
PUT ：在服务器更新资源（客户端提供改变后的完整资源）
PATCH ：在服务器更新资源（客户端提供改变的属性）
DELETE ：从服务器删除资源

过滤

通过在url上传参的形式传递搜索条件

https://api.example.com/v1/zoos?limit=10：指定返回记录的数量

https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置

https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数

https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序

https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

状态码

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当做key。

{
    error: "Invalid API key"
}

Hypermedia API

如果遇到需要跳转的情况 携带调转接口的URL

　ret = {
                code: 1000,
                data:{
                    id:1,
                    name:'小强',
                    depart_id:https://www.4399.com
                }
            }