0

0

Django REST Framework怎么渲染XML

幻夢星雲

幻夢星雲

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

|

710人浏览过

|

来源于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

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()

MaxAI
MaxAI

MaxAI.me是一款功能强大的浏览器AI插件,集成了多种AI模型。

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

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

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

from rest_framework.renderers import XMLRenderer

class CustomXMLRenderer(XMLRenderer): root_tag_name = 'response' # 可设为类属性或从 renderer_context 动态取

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 dict, but got list 已经说得很清楚了。

相关专题

更多
json数据格式
json数据格式

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

411

2023.08.07

json是什么
json是什么

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

532

2023.08.23

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

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

309

2023.10.13

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

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

74

2025.09.10

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

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

1873

2024.04.01

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

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

2085

2024.08.01

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

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

981

2024.11.28

curl_exec
curl_exec

curl_exec函数是PHP cURL函数列表中的一种,它的功能是执行一个cURL会话。给大家总结了一下php curl_exec函数的一些用法实例,这个函数应该在初始化一个cURL会话并且全部的选项都被设置后被调用。他的返回值成功时返回TRUE, 或者在失败时返回FALSE。

425

2023.06.14

PHP 表单处理与文件上传安全实战
PHP 表单处理与文件上传安全实战

本专题聚焦 PHP 在表单处理与文件上传场景中的实战与安全问题,系统讲解表单数据获取与校验、XSS 与 CSRF 防护、文件类型与大小限制、上传目录安全配置、恶意文件识别以及常见安全漏洞的防范策略。通过贴近真实业务的案例,帮助学习者掌握 安全、规范地处理用户输入与文件上传的完整开发流程。

1

2026.01.13

热门下载

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

精品课程

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

共101课时 | 8.2万人学习

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

共39课时 | 3.1万人学习

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

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