RESTful分割API 与 RESTful API设计规范

1.RESTful风格API

详情查看博客地址：https://www.cnblogs.com/xiaonq/p/10053234.html

1.1 什么是RESTful
　　1>.　　REST与技术无关，代表的是 一种软件架构风格 （REST是Representational State Transfer的简称，中 文翻译为“表征状态转移”）

　　2>.　　REST从资源的角度类审视整个网络，它将分布在网络中某个节点的 资源通过URL进行标识

所有的数据，不过是通过网络获取的还是 操作（增删改查） 的数据，都是资源，将一切数据视为资 源是REST区别与其他架构风格的最本质属性

　　3>.　　对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA： Resource Oriented Architecture）

 

　　1.web开发本质
　　1>.　　对数据库中的表进行增删改查操作

　　2>.　　Restful风格就是把所有数据都当做资源，对表的操作就是对资源操作

　　3>.　　在url同通过 资源名称来指定资源

　　4>.　　通过 get/post/put/delete/patch 对资源的操作

 

2.RESTful API设计规范
1. API与用户的通信协议，总是使用HTTPs协议。

2. 域名 

# 1）子域名方式 　　
　　https://api.example.com                # 尽量将API部署在专用域名（会存在跨域问题） 　
　　https://www.example.com                # vue前端域名 
# 2）url方式 　　
　　https://example.org                     # vue前端域名 　　
　　https://example.org/api/               # 后端API域名（不存在跨域）

3. 版本　

URL，如：https://api.example.com/v1/ 
。请求头       跨域时，引发发送多次请求

4. 面向资源编程： 路径，视网络上任何东西都是资源，均使用名词表示

https://api.example.com/v1/zoos/1/ 
https://api.example.com/v1/animals 
https://api.example.com/v1/employees

5. method 

 

GET（查询数据）     # 从服务器取出资源（一项或多项） 
POST（创建数据）    # 在服务器新建一个资源 
PUT（修改数据）     # 在服务器更新资源（客户端提供改变后的完整资源） 
PATCH（修改属性）   # 在服务器更新资源（客户端提供改变的属性） 
DELETE（删除数据）  # 从服务器删除资源

 

6. 过滤，分页，排序：通过在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：指定筛选条件

7. 状态码

'''1. 2XX请求成功''' 
# 1.1 200 请求成功，一般用于GET与POST请求 
# 1.2 201 Created - [POST/PUT/PATCH]：用户新建或修改数据成功。 
# 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务） 
# 204 NO CONTENT - [DELETE]：用户删除数据成功。 
'''2. 3XX重定向''' 
# 301 NO CONTENT - 永久重定向 
# 302 NO CONTENT - 临时重定向
'''3. 4XX客户端错误''' 
# 3.1 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误。 
# 3.2 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。 
# 3.3 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。 
# 3.4 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录。 
# 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格 式）。 
# 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。 
# 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。 
'''4.5 xx服务端错误'''
# 500 INTERNAL SERVER ERROR - [*]: 服务器内部错误，无法完成请求
# 501 NOT Implemnted　　服务器不支持请求的功能，无法完成请求
　　

 

 ///更多状态码请参考： https://www.runoob.com/http/http-status-codes.html