接口复习
1、接口:url+请求参数+响应参数 Postman发送接口请求的工具 method: GET url: https://api.map.baidu.com/place/v2/search params: ak: 6E823f587c95f0148c19993539b99295 region: 上海 query: 肯德基 output: json restful接口规范 https://api.baidu.com/v1/books?ordering=-price&limit=3 get|post|put|patch|delete { ‘status‘: 0, ‘msg‘: ‘ok‘, ‘results‘: [ { ‘title‘: ‘西游记‘, ‘img‘: ‘https://api.baidu.com/media/xyj.png‘ } ] }
接口文档及restful接口规范
解析模块
1)drf给我们通过了多种解析数据包方式的解析类 2)我们可以通过配置来控制前台提交的哪些格式的数据后台在解析,哪些数据不解析 3)全局配置就是针对每一个视图类,局部配置就是针对指定的视图来,让它们可以按照配置规则选择性解析数据
源码入口
# APIView类的dispatch方法中 request = self.initialize_request(request, *args, **kwargs) # 点进去 # 获取解析类 parsers=self.get_parsers(), # 点进去 # 去类属性(局部配置) 或 配置文件(全局配置) 拿 parser_classes return [parser() for parser in self.parser_classes]
全局配置:项目settings.py文件
REST_FRAMEWORK = { # 全局解析类配置 ‘DEFAULT_PARSER_CLASSES‘: [ ‘rest_framework.parsers.JSONParser‘, # json数据包 ‘rest_framework.parsers.FormParser‘, # urlencoding数据包 ‘rest_framework.parsers.MultiPartParser‘ # form-date数据包 ], }
局部配置:应用views.py的具体视图类
from rest_framework.parsers import JSONParser class Book(APIView): # 局部解析类配置,只要json类型的数据包才能被解析 parser_classes = [JSONParser] pass
异常模块
为什么要自定义异常模块
1)所有经过drf的APIView视图类产生的异常,都可以提供异常处理方案 2)drf默认提供了异常处理方案(rest_framework.views.exception_handler),但是处理范围有限 3)drf提供的处理方案两种,处理了返回异常现象,没处理返回None(后续就是服务器抛异常给前台) 4)自定义异常的目的就是解决drf没有处理的异常,让前台得到合理的异常信息返回,后台记录异常具体信息
源码分析
# 异常模块:APIView类的dispatch方法中 response = self.handle_exception(exc) # 点进去 # 获取处理异常的句柄(方法) # 一层层看源码,走的是配置文件,拿到的是rest_framework.views的exception_handler # 自定义:直接写exception_handler函数,在自己的配置文件配置EXCEPTION_HANDLER指向自己的 exception_handler = self.get_exception_handler() # 异常处理的结果 # 自定义异常就是提供exception_handler异常处理函数,处理的目的就是让response一定有值 response = exception_handler(exc, context)
如何使用:自定义exception_handler函数如何书写实现体
# 修改自己的配置文件setting.py REST_FRAMEWORK = { # 全局配置异常模块 ‘EXCEPTION_HANDLER‘: ‘api.exception.exception_handler‘, }
响应组价
响应类构造器:rest_framework.response.Response
def __init__(self, data=None, status=None, template_name=None, headers=None, exception=False, content_type=None): """ :param data: 响应数据 :param status: http响应状态码 :param template_name: drf也可以渲染页面,渲染的页面模板地址(不用了解) :param headers: 响应头 :param exception: 是否异常了 :param content_type: 响应的数据格式(一般不用处理,响应头中带了,且默认是json) """ pass
使用:常规实例化响应对象
# status就是解释一堆 数字 网络状态码的模块 from rest_framework import status就是解释一堆 数字 网络状态码的模块 # 一般情况下只需要返回数据,status和headers都有默认值 return Response(data={数据}, status=status.HTTP_200_OK, headers={设置的响应头})
序列化组价:Serializer
media文件图片获取补充:
在 跟目录下创建 文件夹 media 里面可以放 img文件夹 存放 img文件
# 配置文件 MEDIA_ROOT = os.path.join(BASE_DIR, ‘media‘)
字段
知识点:Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)
Serializer
序列化准备:
models.py
class User(models.Model): SEX_CHOICES = [ [0, ‘男‘], [1, ‘女‘], ] name = models.CharField(max_length=64) pwd = models.CharField(max_length=32) phone = models.CharField(max_length=11, null=True, default=None) sex = models.IntegerField(choices=SEX_CHOICES, default=0) icon = models.ImageField(upload_to=‘icon‘, default=‘icon/default.jpg‘) class Meta: db_table = ‘old_boy_user‘ verbose_name = ‘用户‘ verbose_name_plural = verbose_name def __str__(self): return ‘%s‘ % self.name
models.py 需要注意 choice= 和 upload_to= 的参数
admin.py
from django.contrib import admin from . import models admin.site.register(models.User)
admin.py site.register注册
settings.py
# 注册rest_framework INSTALLED_APPS = [ # ... ‘rest_framework‘, ] # 配置数据库 DATABASES = { ‘default‘: { ‘ENGINE‘: ‘django.db.backends.mysql‘, ‘NAME‘: ‘day70‘, ‘USER‘: ‘root‘, ‘PASSWORD‘: ‘123‘ } } # media资源 MEDIA_URL = ‘/media/‘ # 后期高级序列化类与视图类,会使用该配置 MEDIA_ROOT = os.path.join(BASE_DIR, ‘media‘) # media资源路径 # 国际化配置 LANGUAGE_CODE = ‘zh-hans‘ TIME_ZONE = ‘Asia/Shanghai‘ USE_I18N = True USE_L10N = True USE_TZ = False
注意 media 国际化配置 注册
urls.py 主路由
urlpatterns = [ # ... url(r‘^api/‘, include(‘api.urls‘)), url(r‘^media/(?P<path>.*)‘, serve, {‘document_root‘: settings.MEDIA_ROOT}), ]
注意 serve 后的
urls.py 子路由
urlpatterns = [ url(r‘^users/$‘, views.User.as_view()), url(r‘^users/(?P<pk>.*)/$‘, views.User.as_view()), ]
序列化使用
1)设置需要返回给前台 那些model类有对应的 字段,不需要返回的就不用设置了
2)设置方法字段,字段名可以随意,字段值有 get_字段名 提供,来完成一些需要处理在返回的数据
# 序列化组件 - 为每一个model类提供一套序列化工具类 # 序列化组件的工作方式与django froms组件非常相似 from rest_framework import serializers, exceptions from django.conf import settings from . import models class UserSerializer(serializers.Serializer): name = serializers.CharField() phone = serializers.CharField() # 序列化提供给前台的字段个数由后台决定,可以少提供, # 但是提供的数据库对应的字段,名字一定要与数据库字段相同 # sex = serializers.IntegerField() # icon = serializers.ImageField() # 自定义序列化属性 # 属性名随意,值由固定的命名规范方法提供: # get_属性名(self, 参与序列化的model对象) # 返回值就是自定义序列化属性的值 gender = serializers.SerializerMethodField() def get_gender(self, obj): # choice类型的解释型值 get_字段_display() 来访问 return obj.get_sex_display() icon = serializers.SerializerMethodField() def get_icon(self, obj): # settings.MEDIA_URL: 自己配置的 /media/,给后面高级序列化与视图类准备的 # obj.icon不能直接作为数据返回,因为内容虽然是字符串,但是类型是ImageFieldFile类型 return ‘%s%s%s‘ % (r‘http://127.0.0.1:8000‘, settings.MEDIA_URL, str(obj.icon))
视图层
原文地址:https://www.cnblogs.com/lddragon/p/11689544.html
时间: 2024-11-09 21:21:24