开发者社区

文档建议反馈控制台

最新优惠活动

文章/答案/技术大牛

发布

Django restframework视图集序列化程序KeyError

基础概念

Django REST framework（DRF）是一个强大的、灵活的工具包，用于构建Web API。它基于Django框架，并提供了许多用于构建RESTful API的功能，包括序列化器（Serializers）、视图集（ViewSets）、路由（Routers）等。

序列化器（Serializers）：负责将复杂的数据类型（如Django模型实例）转换为Python数据类型，然后可以轻松地将其渲染为JSON、XML或其他内容类型。

视图集（ViewSets）：提供了一种抽象，允许您将一组逻辑相关的操作（如创建、检索、更新、删除）组合到一个类中。

问题描述

在使用Django REST framework的视图集和序列化器时，可能会遇到KeyError。这通常是由于序列化器在尝试访问不存在的字段或键时引发的。

原因

字段名称错误：序列化器中定义的字段名称与模型中的字段名称不匹配。
数据不完整：传入的数据缺少某些必需的字段。
嵌套序列化器问题：在使用嵌套序列化器时，内部序列化器可能无法正确处理数据。

解决方法

1. 检查字段名称

确保序列化器中定义的字段名称与模型中的字段名称完全匹配。

# models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=100)
    description = models.TextField()

# serializers.py
from rest_framework import serializers
from .models import MyModel

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = ['id', 'name', 'description']

2. 处理数据不完整

在序列化器中添加required=False参数，以允许某些字段可选。

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = ['id', 'name', 'description']
        extra_kwargs = {
            'description': {'required': False}
        }

3. 处理嵌套序列化器

确保嵌套序列化器正确处理数据。

# models.py
class AnotherModel(models.Model):
    my_model = models.ForeignKey(MyModel, on_delete=models.CASCADE)

# serializers.py
class AnotherModelSerializer(serializers.ModelSerializer):
    my_model = MyModelSerializer()

    class Meta:
        model = AnotherModel
        fields = ['id', 'my_model']

示例代码

以下是一个完整的示例，展示了如何使用Django REST framework的视图集和序列化器。

# models.py
from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=100)
    description = models.TextField()

class AnotherModel(models.Model):
    my_model = models.ForeignKey(MyModel, on_delete=models.CASCADE)

# serializers.py
from rest_framework import serializers
from .models import MyModel, AnotherModel

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = ['id', 'name', 'description']

class AnotherModelSerializer(serializers.ModelSerializer):
    my_model = MyModelSerializer()

    class Meta:
        model = AnotherModel
        fields = ['id', 'my_model']

# views.py
from rest_framework import viewsets
from .models import MyModel, AnotherModel
from .serializers import MyModelSerializer, AnotherModelSerializer

class MyModelViewSet(viewsets.ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

class AnotherModelViewSet(viewsets.ModelViewSet):
    queryset = AnotherModel.objects.all()
    serializer_class = AnotherModelSerializer

参考链接

通过以上方法，您应该能够解决在使用Django REST framework时遇到的KeyError问题。

相关搜索:在Django Restframework序列化程序中过滤模型父对象如何在Django Restframework嵌套序列化程序中创建如何在django restframework中将多个数据写入嵌套序列化程序 django-restframework将关系序列化为字典而不是数组如何使用Django-Restframework序列化包含列表的字典？django-restframework。如何在序列化程序中更改多对多字段名？react应用程序和django restframework中的CORS 序列化程序Django Django模型序列化程序 django rest的视图集调用默认序列化程序的create方法，而不是覆盖方法 Django REST嵌套序列化程序条件字段序列化程序Django Django序列化程序-返回特定字段使用django 2定制序列化程序 Django Rest框架:测试序列化程序单元测试django序列化程序 Django REST嵌套对象序列化程序 Django -序列化程序未设置ManyToManyField Django序列化程序定义初始对象 django序列化程序动态设置属性

相关搜索:

页面内容是否对你有帮助？

有帮助

没帮助

相关·内容

第 7 篇：文章详情的 API 接口

一旦我们使用了视图集，并实现了 HTTP 请求对应的 action 方法（对应规则的说明见使用视图集简化代码），将其在路由器中注册后，django-restframework 自动会自动为我们生成对应的 API 接口。

03

第 10 篇：评论接口

此前我们一直在操作博客文章（Post）资源，并借此介绍了序列化器（Serializer）、视图集（Viewset）、路由器（Router）等 django-rest-framework 提供的便利工具，借助这些工具，就可以非常快速地完成 RESTful API 的开发。

03

初次就这么给了你(Django-rest-framework)

工程已经创建好了，需要cd进工程里边，关键是manage.py在工程里边，我们就需要借用manage.py来进行其他的操作了。

02

RESTframework_一

版权声明：Copyright © https://blog.csdn.net/zzw19951261/article/details/80830234

02

DRF框架学习（三）

1.视图中的request对象不再是Django中 HttpRequest类的对象，而是由DRF框架封装成的 Request类的对象。

02

DRF框架学习（二）

Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。

03

DRF工程搭建

DRF是以Django扩展应用的方式提供的，所以我们可以直接利用已有的Django环境而无需从新创建。（若没有Django环境，需要先创建环境安装Django）

01

重点内容回顾-DRF

Overthinking ruins you. Ruins the situation, twists it around, makes you worry and just makes everything much worse than it actually is.

02

构建强大的API-Django中的REST框架探究与实践

在当今的Web开发中，构建强大的API已经成为了不可或缺的一部分。而在Python领域，Django框架提供了强大的REST框架，为开发者提供了一种高效、灵活的方式来构建和管理API。本文将深入探讨Django中REST框架的使用，并通过代码实例和解析来展示其强大之处。

02

第 9 篇：实现分类、标签、归档日期接口

我们的博客有一个侧边栏功能，分别列出博客文章的分类列表、标签列表、归档时间列表，通过点击侧边栏对应的条目，还可以进入相应的页面。例如点击某个分类，博客将跳转到该分类下全部文章列表页面。这些数据的展示都需要开发对应的接口，以便前端调用获取数据。

03

Django REST Framework-如何使用视图集（一）

在这个例子中，我们定义了一个 BookViewSet 视图集，并将 Book 模型的查询集设置为 Book.objects.all()，将 BookSerializer 序列化器设置为默认序列化器。

04

Django REST Framework-视图集（一）

在 Django REST Framework 中，视图集（Viewset）是一种简化了视图函数（View Function）的开发方式，它可以让开发者更快速、更方便地创建 RESTful API。

08

浅谈django不使用restframework自定义接口与使用的区别

django可以使用restframework快速开发接口，返回前端所需要的json数据，但是有时候利用restframework开发的接口并不能满足所有的需求，这时候就需要自己手动开发接口，也就是将需要用到的某些对象转化为需要使用的json数据，今天记录一下django自己定义接口的一种方法与思路

03

Django REST Framework-视图集类型（一）

在 Django REST Framework 中，视图集（Viewset）是一种方便的 API 开发方式，它将视图（View）和序列化器（Serializer）组合起来，提供了一组标准的 API 操作（列表、创建、更新、删除、详情等），可以大大简化 API 的编写和维护工作，提高开发效率和代码可读性。

02

【愚公系列】2022年04月 Python教学课程 70-DRF框架之视图集

ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。

03

django restframework serializer 增加自定义字段操作

在使用django restframework serializer 序列化在django中定义的model时，有时候我们需要额外在serializer中增加一些model中没有的字段。有两种方法实现这个目的。

04

第 11 篇：基于 drf-haystack 的文章搜索接口

在 django 博客教程中，我们使用了 django-haystack 和 Elasticsearch 进行文章内容的搜索。django-haystack 默认返回的搜索结果是一个类似于 django QuerySet 的对象，需要配合模板系统使用，因为未被序列化，所以无法直接用于 django-rest-framework 的接口。当然解决方案也很简单，编写相应的序列化器将返回结果序列化就可以了。

02

【愚公系列】2022年04月 Python教学课程 62-DRF框架介绍

Django REST framework框架是一个用于构建WebAPl的强大而又灵活的工具。通常简称为DRF框架或REST framework。

02

Django DRF路由与扩展功能的实现

ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。

03

DjangoRESTframework（补充）

版权声明：Copyright © https://blog.csdn.net/zzw19951261/article/details/80995504

03

drf之请求、响应、视图

drf 传入视图的request 不再是Django默认的HttpRequest对象，而是drf 提供的拓展了HttpRequest 类的Request 类的对象。

02

DRF 视图组件

先来看看这其中的人情世故：两个视图基本类，五个扩展类，九个视图子类，视图集方法，视图集··

01

第 16 篇：别再手动管理接口文档了

大多数情况下，开发的接口都不是给开发这个接口的人用的，所以如果没有接口文档，别人就无法知道有哪些接口可以调用，即使知道了接口的 URL，也很难知道接口需要哪些参数，即使知道了这些参数，也可能无法理解这些参数的含义。因此接口文档应该是项目必不可少的配置。

02

第 15 篇：接口的单元测试

一个完整的项目，无论是个人的还是公司的，自动化的单元测试是必不可少，否则以后任何的功能改动将成为你的灾难。

02

第 5 篇：用视图集，简化你的代码

在 RESTful 架构中，对资源的常规操作无非就是查询、新增、修改、删除等这么几种。为此，django-rest-framework 分别提供了对应通用类视图函数。但是，如果对同一个资源的不同操作逻辑分散在各个视图函数中，从逻辑上来说不太合理，实际中管理起来也不是很方便，还会产生很多重复性的代码。因此，django-rest-framework 引入了视图集（Viewsets），把对同一个资源的不同操作，集中到一个类中。同样的，针对 Web 开发中的常见逻辑，django-rest-framework 也提供了通用视图集，进一步简化开发工作。

01

django restframework serializer 增加自定义字段

在使用django restframework serializer 序列化在django中定义的model时，有时候我们需要额外在serializer中增加一些model中没有的字段。有两种方法实现这个目的。

01

drf框架中所有视图及用法

from rest_framework import views, generics, mixins, viewsets

03

Django-DRF | APIView 视图类

Django REST框架构建Web API。Django网络应用开发的5项基础核心技术包括模型（Model）的设计，URL 的设计与配置，View（视图）的编写，Template（模板）的设计和Form(表单)的使用。

02

python教程

在做其他事之前，我们会用virtualenv创建一个新的虚拟环境。这将确保我们的包配置与我们正在工作的其他项目完全隔离。

01

Vue+Django2.0 restframework打造前后端分离的生鲜电商项目（3）

1.drf前期准备 1.django-rest-framework官方文档 https://www.django-rest-framework.org/ #直接百度找到的djangorestframe

05

Flask框架在Python面试中的应用与实战

Django REST framework (DRF) 是一个强大而灵活的工具包，用于构建Web API，特别是基于Django的应用程序。在Python面试中，对DRF的理解与实际应用能力是衡量候选人Web服务开发能力的重要指标。本篇博客将深入浅出地探讨DRF面试中常见的问题、易错点以及应对策略，并结合实例代码进行讲解。

01

drf的接口文档生成与管理

在项目开发中，例如web项目的前后端分离开发，需要由前后端相关人员共同定义接口，编写接口文档。之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。一个好的接口文档能够帮助我们快速上手这类项目、便于阅读已有代码、对接接口自动化测试等等

01

第 6 篇：分页接口

如果没有设置分页，django-rest-framework 会将所有资源类表序列化后返回，如果资源很多，就会对网站性能造成影响。为此，我们来给博客文章列表 API 添加分页功能。

02

DRF自动生成OpenAPI文档

API schemas是非常有用的，可以帮助我们生成接口文档以及可与API交互的动态客户端。Django REST Framework支持自动生成OpenAPI schemas，但是目前支持的不是非常完善，需要手动修改的地方过多。在这里我们使用drf-spectacular这个第三方库来自动生成OpenAPI schemas.

02

DRF框架学习（四）

重写 get_serializer_class和get_queryset,根据不同的操作返回不同的序列化器类和不同的查询集。

04

跟着官方文档学Python——Django Rest framework

这周将会持续更新跟着官方文档学Python系列文章，主要是围绕web框架以及其他后端组件的官方文档展开学习。日拱一卒，让我们开始吧！

01

Django rest-framework视图家族

总结：GenericAPIView就是在APIView基础上额外提供了三个方法和三个类属性，如果不配合视图工具类，则体现不出来优势所在

02

Django+RestFramework API接口及接口文档并返回json数据操作

GitHub：https://github.com/xingjidemimi/DjangoAPI.git

02

django-rest-framewor

REST是一种软件架构设计风格，不是标准，也不是具体的技术实现，只是提供了一组设计原则和约束条件。

01

Python进阶41-drf框架(三)

-多年互联网运维工作经验，曾负责过大规模集群架构自动化运维管理工作。 -擅长Web集群架构与自动化运维，曾负责国内某大型金融公司运维工作。 -devops项目经理兼DBA。 -开发过一套自动化运维平台（功能如下）： 1)整合了各个公有云API，自主创建云主机。 2)ELK自动化收集日志功能。 3)Saltstack自动化运维统一配置管理工具。 4)Git、Jenkins自动化代码上线及自动化测试平台。 5)堡垒机，连接Linux、Windows平台及日志审计。 6)SQL执行及审批流程。 7)慢查询日志分析web界面。

02

Django REST 框架详解 05 | 视图家族 Mixins

Django REST framework 为了方便视图类的操作，构建了包括以下几种视图类和工具集：

01

django 1.8 官方文档翻译： 13-9-1 如何使用会话

Django 提供对匿名会话的完全支持。其会话框架让你根据各个站点的访问者存储和访问任意数据。它在服务器端存储数据并抽象Cookie 的发送和接收。Cookie 包含会话的ID —— 不是数据本身（除非你使用基于Cookie 的后端）。

02

不会DRF？源码都分析透了确定不来看？

目录不会DRF？源码都分析透了确定不来看？快速使用DRF写出接口序列化和反序列化 drf快速使用 views.py serializer.py urls.py 在settings的app中注册 models.py postman测试 CBV源码流程分析 Django View和DRF APIView的小插曲 DRF之APIView和Request对象分析 APIView的执行流程 Request对象分析原来的django中没有request.data，造一个！不会DRF？源码都分析透了确定不来看？

01

python后台框架选型

后台框架选型 Flask与Django对比数据库支持管理系统性能第三方库支持代码可读性、是否轻量、可维护性、可扩展性版本迭代难易程度与前台交互目录结构 django项目目录结构应用结构

02

测试开发进阶(二十九)

rest_framework.generics.ListCreateAPIView

01

Python 如何开发出RESTful Web接口，DRF框架助力灵活实现!

Django Rest Framework（DRF）是构建强大且灵活的Web API的优秀工具。它基于Django，提供了一套用于构建Web API的组件和工具，简化了API开发过程，同时保留了Django的优雅和强大。

02

DRF框架中的英文单词

1. prefix/'prifɪks/前缀，我们在路由配置的时候经常看见这个单词。在flask中，我们可以在设置url的时候为了区别视图，在类似功能的url全部加一个前缀。

03

Django Rest Swagger生成api文档

Swagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：

01

Django REST Framework-如何使用过滤器

Django REST Framework (DRF) 是一个开源的 Web 框架，它建立在 Django 上，可以帮助你轻松地构建 RESTful API。DRF 提供了很多有用的功能，其中之一就是过滤器（filters）。

04

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云

扫码加入开发者社群

相关资讯

热门标签

活动推荐

运营活动

活动名称

广告关闭