一.简介
1.简介
RESTful：Representational State Transfer (资源Resources)表现层状态转化。
随着互联网的发展, 客户端层出不穷, 以APP、微信、PC浏览器为代表, 服务端业务逻辑是基本一致的。一套统一的API接口将方便不同客户端进行数据的访问。
RESTful是目前最流行的 API 设计规范(是规范，并非强制要求)，用于 Web 数据接口的设计。
资源（Resources）：网络上的一个实体，或者说是网络上的一个具体信息，并且每个资源都有一个独一无二得URI与之对应；获取资源-直接访问URI即可
表现层（Representation）：如何去表现资源 - 即资源得表现形式；如HTML , xml , JPG , json等
状态转化（State Transfer）：访问一个URI即发生了一次客户端和服务端得交互；此次交互将会涉及到数据和状态得变化，客户端需要通过某些方式触发具体得变化 - HTTP method 如 GET， POST，PUT(整体更新)，PATCH(部分更新)，DELETE 等
2.RESTful的特征
- 每一个URI代表一种资源
- 客户端和服务器端之前传递着资源的某种表现
- 客户端通过HTTP的几个动作 对 资源进行操作 - 发生‘状态转化’
3.接口设计
-
域名中出现api字样
https://api.example.com 或 https://example.org/api/ -
版本：接口可能出现新老版本共存
https://api.example.com/v1/ https://api.example.com/v2/ -
路径中避免使用动词，资源用名词(负数)表示
https://api.example.com/v1/users
https://api.example.com/v1/animals -
HTTP动词语义
- GET（SELECT）：从服务器取出资源（一项或多项）。
- POST（CREATE）：在服务器新增一个资源。
- PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
- PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。一般不用，仅使用PUT即可
- 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：删除某个指定动物园的指定动物
5.巧用查询字符串
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?type_id=1：指定筛选条件
6.用HTTP响应码表达 此次请求结果
200 OK - [GET]：服务器成功返回用户请求的数据
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 - [*]：服务器发生错误
自定义内部code 进行响应
{'code':200, 'data': {}, 'error': xxx}
7.返回结果
GET /users：返回资源对象的列表（数组）
GET /users/guoxiaonao：返回单个资源对象
POST /users：返回新生成的资源对象
PUT /users/guoxiaonao：返回完整的资源对象
PATCH /users/guoxiaonao：返回完整的资源对象
DELETE /users/guoxiaonao：返回一个空文档
8.前后端接口示例
前端url：/login -> 后端url：POST /token 语义：将每次登陆看作是创建一个token
