0

0

Django REST Framework怎么渲染XML

幻夢星雲

幻夢星雲

发布时间:2026-01-13 09:15:28

|

730人浏览过

|

来源于php中文网

原创

drf 默认不启用xmlrenderer,需手动在default_renderer_classes中添加;xmlrenderer要求数据为字典且顶层键作根元素,列表须包装为字典;自定义根名需子类化xmlrenderer。

django rest framework怎么渲染xml

XML renderer 在 DRF 中默认不启用

DRF 默认只注册 JSONRendererXMLRenderer 虽然内置但未自动加入 DEFAULT_RENDERER_CLASSES。直接返回 XML 会触发 NotAcceptable (406) 错误,浏览器curl -H "Accept: application/xml" 都拿不到 XML 响应。

手动启用 XMLRenderer 的两种方式

推荐在全局设置中添加,避免每个视图重复声明。注意顺序:XML 渲染器需放在 JSON 之后,否则 Accept: */* 可能优先匹配 XML(部分客户端行为不一致)。

  • settings.py 中修改 REST_FRAMEWORK 配置:
REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.XMLRenderer',  # ← 显式加入
    ],
}
  • 若仅对某个视图启用,可在视图类中指定:
from rest_framework.renderers import XMLRenderer
<p>class MyAPIView(APIView):
renderer_classes = [XMLRenderer, JSONRenderer]  # 顺序影响 content-negotiation
def get(self, request):
return Response({'name': 'Alice', 'age': 30})

XML 输出结构受 serializer 字段名和嵌套深度直接影响

XMLRenderer 不支持任意嵌套对象或列表顶层渲染——它要求数据是字典,且顶层键将成为根元素名。传入 [{'id': 1}, {'id': 2}] 会报 TypeError: object of type 'list' has no len()

AI Undetect
AI Undetect

让AI无法察觉,让文字更人性化,为文字体验创造无限可能。

下载
  • 正确写法:用字典包装列表,并指定根标签名(通过 renderer_context 或自定义)
  • 常见翻车点:Response([obj1, obj2]) → 必须改为 Response({'users': [obj1, obj2]})
  • 字段值为 None 时,XML 中该元素仍会出现但为空标签(<email></email>),不会被跳过

自定义 XML 根元素名或添加命名空间

DRF 的 XMLRenderer 不提供开箱即用的命名空间或根名覆盖接口,但可通过子类轻量扩展:

from rest_framework.renderers import XMLRenderer
<p>class CustomXMLRenderer(XMLRenderer):
root_tag_name = 'response'  # 可设为类属性或从 renderer_context 动态取</p><pre class='brush:php;toolbar:false;'>def render(self, data, accepted_media_type=None, renderer_context=None):
    if data and isinstance(data, dict) and 'root_tag_name' in renderer_context:
        self.root_tag_name = renderer_context['root_tag_name']
    return super().render(data, accepted_media_type, renderer_context)
  • 使用时,在视图中传入上下文:return Response(data, renderer_context={'root_tag_name': 'book_list'})
  • 命名空间需手动拼接字符串或改用第三方库(如 djangorestframework-xml 的增强版)
  • 注意:子类化后需在 renderer_classes 中替换原 XMLRenderer

XML 渲染真正麻烦的不是配置,而是数据结构必须严格适配其字典+单根约束;很多开发者卡在 Response([...]) 上,却没意识到错误信息里那句 Expected a <code>dict, but got list 已经说得很清楚了。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Web 框架 Django 深度开发
Python Web 框架 Django 深度开发

本专题系统讲解 Python Django 框架的核心功能与进阶开发技巧,包括 Django 项目结构、数据库模型与迁移、视图与模板渲染、表单与认证管理、RESTful API 开发、Django 中间件与缓存优化、部署与性能调优。通过实战案例,帮助学习者掌握 使用 Django 快速构建功能全面的 Web 应用与全栈开发能力。

154

2026.02.04

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

452

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

328

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1939

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2116

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1146

2024.11.28

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

3

2026.03.03

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 9.9万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号