1. restful风格
一个用于指导我们定义接口开发的规范,标准,风格
HTTP接口(web接口,网络api)
请求方式:GET,POST,PUT,DELETE
url:协议,域名(ip),端口(进程)和请求路径
http://www.meiduo .site:8080/books/
请求参数:
1.查询字符串参数:
http://www.meiduo .site:8080/books/**?btitle=射雕英&pub_data =1999-9-9**
django提取:request.GET.get
2.url的路径参数:http://www.meiduo .site:8080/books/1/
django提取:path,re_path,url
3.请求头参数
GET /books/ HTTP/1.1
Content-Type:application/json
Orign: http://ww.meiduo.site:8080
4.请求体参数
{“btitle”:“围城”}
表单格式:
POST /books/ HTTP/1.1
Content-Type:application/x-www-form-urlencoded
Orign: http://ww.meiduo.site:8080
btitle =围城&bpub_data=1999-9-9
响应参数
2. restful设计方法
1.域名
专用域名:http://www.meiduo.site
Django动态服务器:www.meiduo.site
图片服务(fdfs):image.meiduo.site
game.qq.com:游戏服务相关的接口
pay.qq.com:支付相关的接口
mail.qq.com:邮件相关的接口
主域名
users
django服务器主域名:www.meiduo.site:8000
用户模块:www.meiduo.site:8000/users/
订单模块:www.meiduo.site:8000/orders/
re_path(‘users/’, include(‘users.urls’)),
/users/show/,/users/delete/
2.版本号
说明:一套接口:随着开发进度,接口需要更新,后端需要区别接口调用的版本,将版本号写入路径或者HTTP头信息中
3.路径
路径又称终点(endpoint),表示api具体网址,每个网址表示一种资源(resource),所以要用名词,复数表示路径
3. 接口定义restful规则
GET + /books/:货物books列表资源 BookView.get(数据流向:后端给前段)
GET + books/1/:新建一本书
POST + /books/:新建一本书(数据流向:前段给后端)
json格式
def post(self, request):
1.提取参数
data = json.loads(request.body.decode())
2.校验参数
btitle = data.get(‘btitle’)
btitle_len = len(title)
if btitle_len >= 20:
return JsonResponse({‘errmsg’: ‘btitle长度不能超过20’},status =400)
3.数据处理(新增)
book = BookInfo.objects.create(**data)
4.构建响应
return JsonResponse({
‘btitle’: book.btitle,
‘btitle_pub_date’:book.pub_date
})
使用Postman
PUST + /books/1/:更新主键为1书
DELETE + /books/2/:删除主键为3的书
5.过滤信息(filtering)
api提供参数,过滤返回参数(查询字符串参数)
6.状态码
7.错误处理
8.返回结果
9.其他(尽量使用json,不要用xml)
REST接口开发核心任务(DRF框架遵循了restful风格)
DRF提供了一系列的函数/类,来帮助我们快速地完成序列化操作
-
序列化:把模型类转化为json返回
-
反序列化:json字符串–》字典–》数据校验–有效数据–》新建/更新模型类对象
-
操作数据库:Django的模型类语法