Python Web框架 Django - 分页、过滤、自定义返回数据格式

rest配置分页

# rest配置
REST_FRAMEWORK = {
    # 分页配置
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    # 设置一页的条数
    'PAGE_SIZE': 2,

}

接口返回的数据

"count": 7,
        "next": "http://127.0.0.1:8080/api/article/art/?page=2",
        "previous": null,
        "results": [
            {
                "id": 2,
                "title": "标题1 ",
                "desc": "描述1 ",
                "content": "内容1 ",
                "atype": "python"
            },
            {
                "id": 3,
                "title": "标题啊啊",
                "desc": "来点描述",
                "content": "这里搞点正文",
                "atype": "C"
            }
        ]

处理patch访问时的空值

from rest_framework import serializers

from article.models import Article


class ArticleSerializer(serializers.ModelSerializer):
    desc = serializers.CharField(min_length=2,
                                 max_length=100,
                                 error_messages={
                                     'required': '描述必填',
                                     'max_length': '描述不超过100个字符',
                                     'min_length': '描述不少于两个字符'
                                 })
    title = serializers.CharField(min_length=2,
                                  max_length=100,
                                  error_messages={
                                      'required': '标题必填',
                                      'min_length': '标题不少于两个字符',
                                      'max_length': '标题不超过100个字符'
                                  })
    content = serializers.CharField(min_length=5,
                                    error_messages={
                                        'required': '内容必填',
                                        'min_length': '内容不少于5个字符'
                                    })

    class Meta:
        # 序列化的模型
        model = Article
        # 需要序列化的字段
        fields = ['id', 'title', 'desc', 'content', 'atype']

过滤

安装过滤的库

pip install django-filter

配置settings.py文件

# rest配置
REST_FRAMEWORK = {
    # 分页配置
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    # 设置一页的条数
    'PAGE_SIZE': 2,

    # 配置过滤
    'DEFAULT_FILTER_BACKENDS': ('rest_framework.filters.DjangoFilterBackend',
                                'rest_framework.filters.SearchFilter'),

}

在views中指定filter_class

class ArticleView(viewsets.GenericViewSet,
                  mixins.ListModelMixin,
                  mixins.DestroyModelMixin,
                  mixins.CreateModelMixin,
                  mixins.UpdateModelMixin,
                  mixins.RetrieveModelMixin):
    # 查询返回的数据
    queryset = Article.objects.filter(is_delete=0)
    # 序列化返回的文章数据
    serializer_class = ArticleSerializer
    # 过滤
    filter_class = ArticleFilter

filter_class中的内容

from rest_framework import filters
import django_filters

from article.models import Article


class ArticleFilter(filters.FilterSet):

    # 过滤URL中title参数
    title = django_filters.CharFilter('title', lookup_expr='contains')
    # 过滤URL中desc参数
    desc = django_filters.CharFilter('desc', lookup_expr='contains')
    # 过滤URL中content参数
    content = django_filters.CharFilter('content', lookup_expr='contains')
    # 过滤URL中时间最小值min_time
    min_time = django_filters.DateTimeFilter('create_time', lookup_expr='gt')
    # 过滤URL中时间最大值max_time
    max_time = django_filters.DateTimeFilter('create_time', lookup_expr='lt')

    class Meta:
        model = Article
        fields = ['title', 'desc', 'content', 'min_time', 'max_time']

多对多关联关系过滤

修改序列化类
序列化时会默认调用to_representation方法，返回的结果为当前的instance对象的序列化结果

from rest_framework import serializers

from article.models import Article


class ArticleSerializer(serializers.ModelSerializer):
    desc = serializers.CharField(min_length=2,
                                 max_length=100,
                                 error_messages={
                                     'required': '描述必填',
                                     'max_length': '描述不超过100个字符',
                                     'min_length': '描述不少于两个字符'
                                 })
    title = serializers.CharField(min_length=2,
                                  max_length=100,
                                  error_messages={
                                      'required': '标题必填',
                                      'min_length': '标题不少于两个字符',
                                      'max_length': '标题不超过100个字符'
                                  })
    content = serializers.CharField(min_length=5,
                                    error_messages={
                                        'required': '内容必填',
                                        'min_length': '内容不少于5个字符'
                                    })

    class Meta:
        # 序列化的模型
        model = Article
        # 需要序列化的字段
        fields = ['id', 'title', 'desc', 'content', 'atype']

    def to_representation(self, instance):
        # 序列化时会默认调用该方法，返回的结果为当前的instance对象的序列化结果
        data = super().to_representation(instance)
        if instance.atype:
            data['atype'] = instance.atype.t_name
        return data

自定义返回数据格式

配置自定义render

# rest配置
REST_FRAMEWORK = {
    # 分页配置
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    # 设置一页的条数
    'PAGE_SIZE': 2,

    # 配置过滤
    'DEFAULT_FILTER_BACKENDS': ('rest_framework.filters.DjangoFilterBackend',
                                'rest_framework.filters.SearchFilter'),

    # 配置自定义render
    'DEFAULT_RENDERER_CLASSES': (
        'utils.MyRender.CustomRenderer',
    )

}

修改在settings中指定的自定义render类


from rest_framework.renderers import JSONRenderer


class CustomRenderer(JSONRenderer):
    """
    重构返回结果的函数
    {
        'code': 200,
        'msg': '请求成功',
        'data': {

        }
    }

    """
    def render(self, data, accepted_media_type=None, renderer_context=None):
        try:
            code = data.pop('code')
            msg = data.pop('msg')
        except:
            code = 200
            msg = '请求成功'

        my_data = {
            'code': code,
            'msg': msg,
            'data': data
        }
        return super().render(my_data, accepted_media_type=None, renderer_context=None)

views.py文件内容

from django.shortcuts import render

from rest_framework import mixins, viewsets, status
from rest_framework.response import Response

from article.article_filter import ArticleFilter
from article.article_serializer import ArticleSerializer
from article.models import Article


class ArticleView(viewsets.GenericViewSet,
                  mixins.ListModelMixin,
                  mixins.DestroyModelMixin,
                  mixins.CreateModelMixin,
                  mixins.UpdateModelMixin,
                  mixins.RetrieveModelMixin):
    # 查询返回的数据
    queryset = Article.objects.filter(is_delete=0)
    # 序列化返回的文章数据
    serializer_class = ArticleSerializer
    # 过滤
    filter_class = ArticleFilter

    def perform_destroy(self, instance):
        instance.is_delete = 1
        instance.save()

    def retrieve(self, request, *args, **kwargs):
        try:
            instance = self.get_object()
            serializer = self.get_serializer(instance)
            return Response(serializer.data)
        except:
            data = {}
            data['code'] = 500
            data['msg'] = '获取数据失败'
            return Response(data)

    # def get_queryset(self):
    #     search_title = self.request.GET.get('title')
    #     search_desc = self.request.GET.get('desc')
    #     search_content = self.request.GET.get('content')
    #     # 既要搜索title, desc,content
    #     if not search_title and not search_desc and not search_content:
    #         return self.queryset
    #     return self.queryset.filter(title__contains=search_title)
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,163评论 6赞 498
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,301评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,089评论 0赞 352
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,093评论 1赞 292
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,110评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,079评论 1赞 295
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,005评论 3赞 417
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,840评论 0赞 273
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,278评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2赞 332
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,394评论 5赞 343
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,980评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2赞 352