"""
1、接口:采用某种请求方式提交参数,获得响应的响应数据结果的url链接
url链接: https://api.*.com/users/
请求方式: get
请求参数: {...}
响应结果: {...}
2、接口文档:将接口的四部分编写成文档形式(前台后台测试...),Yapi平台编写
3、restful接口规范:
url链接: https | api | books,books/(pk) | v1,v2 | ?ordering=id
请求方式:get查 | post增 | put整体改 | patch局部改 | delete删
响应结果:网络状态码与状态信息 | 数据状态码 | 数据状态信息 | 数据体(子资源返回子资源接口)
4、规范下的接口
url('^books/$') => BookView
url('^books/?P<pk>\d+/$')=> BookView
BookView要实现五个方法,十个逻辑
def get(self, request, *args, **kwargs):
pk = kwargs.get('pk')
if pk:
# 单查
else:
群查
"""
"""
1、APIView请求生命周期
APIView的as_view(局部禁用csrf) => 走父级的as_view调用dispatch分发请求 => APIView自己重写了dispatch,使用自己完成分发 => 分发前完成request二次封装、数据解析 => 三大认证 => 请求的实际响应(自己的视图类的处理分发) => 出现了异常,就会交给异常模块处理异常 => 响应模块完成响应、渲染模块可以json或浏览器两种方式渲染
2、请求模块:
request._request 被 request完全兼容
request.query_params | request.data
3、解析模块:
局部配置:parser_classes = [JSONParser, FormParser, MultiPartParser]
全局配置:
'DEFAULT_PARSER_CLASSES': [
'rest_framework.parsers.JSONParser',
'rest_framework.parsers.FormParser',
'rest_framework.parsers.MultiPartParser'
],
4、响应模块:
Respose(data=常量|列表|字典, status=网络状态码)
5、渲染模块:
局部配置:renderer_classes = [JSONRenderer, BrowsableAPIRenderer]
全局配置:
'DEFAULT_RENDERER_CLASSES': [
'rest_framework.renderers.JSONRenderer',
'rest_framework.renderers.BrowsableAPIRenderer', # 上线后尽量关闭
],
6、异常模块
settings中配置:'EXCEPTION_HANDLER': 'api.exception.exception_handler',
重写exception_handler方法:
"""
# 一定要在settings文件中将异常模块配置自己的异常处理函数
from rest_framework.views import exception_handler as drf_exception_handler
from rest_framework.response import Response
# 先交个drf处理客户端异常,如果结果response为None代表服务器异常,自己处理
# 最终一定要在日志文件中记录异常现象
def exception_handler(exc, context):
response = drf_exception_handler(exc, context)
detail = '%s - %s - %s' % (context.get('view'), context.get('request').method, exc)
if not response: # 服务端错误
response = Response({'detail': detail})
else:
response.data = {'detail': detail}
# 核心:要将response.data.get('detail')信息记录到日志文件
# logger.waring(response.data.get('detail'))
return response
```
原文:https://www.cnblogs.com/zhm-cyt/p/12093463.html