Reatful规范

Posted 2020-11-22 yanjiayi098-001

Reatful规范

drf框架的作用

作用：写接口

什么是接口：

URL（前后台信息交互的媒介）

明确了请求方式，提供对应后台所需参数，请求url链接可以得到后台的相应数据

怎么写接口：

参照某种规则（规范）书写url链接，同时根据规则制定请求方式，数据与响应结果。

接口文档：

提供给前后台开发人员与测试人员查看

接口规范：

webapi接口规范：restful

URL设计

请求方式

数据的安全保障

利用https协议

接口特征表现的两种方式

• https://api.baidu.com
• https://www.baidu.com/api

注：看到api字眼，就代表该请求url链接是完成前后台数据交互的

多数据版本共存

• https://api.baidu.com/v1
• https://api.baidu.com/v2

注：url链接中的v1、v2就是不同数据版本的提现（只有在一种数据资源有多版本的情况下）

数据即资源

接口一般都是完成前后台数据的交互，交互数据就称之为资源

eg：https://api.baidu.com/books

注：一般提倡用资源的复数形式，不要出现操作资源的动词

资源操作由请求方式决定

操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作,eg:

'''
https://api.baidu.com/books - get请求：获取所有书
https://api.baidu.com/books/1 - get请求：获取主键为1的书
https://api.baidu.com/books - post请求：新增一本书书
https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
https://api.baidu.com/books/1 - delete请求：删除主键为1的书
'''

响应状态码

200：常规请求

201：创建成功

301：永久重定向

302：暂时重定向

403：请求无权限

404：请求路径不存在

405：请求方法不存在

500：服务器异常

响应结果

响应数据要有状态码、状态信息以及数据本身

}
"status": 0,
 "msg": "ok",
 "results":[
 {
 "name":"肯德基(罗餐厅)",
 "location":{
 "lat":31.415354,
 "lng":121.357339
 },
 "address":"月罗路2380号",
 "province":"上海市",
 "city":"上海市",
 "area":"宝山区",
 "street_id":"339ed41ae1d6dc320a5cb37c",
 "telephone":"[phone]",
 "detail":1,
 "uid":"339ed41ae1d6dc320a5cb37c"
 }
 ...
 ]
}

需要URL请求的资源需要访问资源的请求链接

{
 "status": 0,
 "msg": "ok",
 "results":[
 {
 "name":"肯德基(罗餐厅)",
 "img": "https://image.baidu.com/kfc/001.png"
 }
 ...
 ]
}