如何在Python Django REST Framework中实现基于Header的版本控制?

酷晨姑娘_3023

酷晨姑娘_3023

2026-07-30

294人浏览

原创

acceptheaderversioning要求accept头严格为“media-type; version=xxx”格式,因它仅匹配分号后带空格的version参数;格式不符则request.version为none,需配置default_versioning_class、default_version、allowed_versions和version_param才生效。

如何在python django rest framework中实现基于header的版本控制?

直接用 AcceptHeaderVersioning,但必须确保客户端请求头里带 Accept: application/json; version=v1 这种格式,否则 request.version 会是 None 或触发 404。

为什么 Accept 头格式必须严格匹配?

AcceptHeaderVersioning 不解析任意键值对,它只从 Accept 请求头中提取 version=xxx 这个子串,且前提是整个头值符合 media-type; param=value 结构。常见错误包括:

  • 发 Accept: v1 → 解析失败,request.version 为 None
  • 发 Accept: application/json, version=v1(逗号分隔)→ 不识别,跳过
  • 发 Accept: application/json;v=v1(缺少空格、参数名不对)→ 匹配不上 version 键

正确写法只有:Accept: application/json; version=v1 或 Accept: text/html; version=v2 —— 分号后必须有空格,且 version= 是独立参数。

settings.py 配置要点

全局启用时,REST_FRAMEWORK 中这几项不能少:

  • 'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.AcceptHeaderVersioning'
  • 'DEFAULT_VERSION': 'v1'(当请求头没提供版本时 fallback 的值)
  • 'ALLOWED_VERSIONS': ['v1', 'v2'](必须显式声明,否则非默认版本会报 NotFound)
  • 'VERSION_PARAM': 'version'(虽然 header 模式不依赖 URL 参数,但该配置仍被底层校验逻辑读取)

注意:VERSION_PARAM 在 header 模式下不用于解析,但它参与 is_allowed_version() 校验,漏配会导致合法版本被拒绝。

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载

视图里怎么安全读取和分支?

request.version 可能为 None(解析失败)、字符串(如 'v1')或 'v1' 以外的非法值(已通过 ALLOWED_VERSIONS 拦截)。实际判断建议:

  • 不要直接写 if request.version == 'v1' —— 先确认不是 None
  • 用 if request.version in ('v1', 'v2') 更稳妥,避免拼写错误
  • 序列化类切换示例:
    def get_serializer_class(self):
        if self.request.version == 'v2':
            return UserSerializerV2
        return UserSerializerV1

另外,request.versioning_scheme 是 AcceptHeaderVersioning 实例,可用于反向生成兼容 header 的 URL(极少用,但调试时可查 request.versioning_scheme.reverse(...))。

调试时怎么快速验证 header 是否生效?

在视图 get() 开头加一行:

print(f"Accept header: {request.META.get('HTTP_ACCEPT')}")
print(f"Resolved version: {request.version}")
然后用 curl 测试:
curl -H "Accept: application/json; version=v2" http://localhost:8000/api/users/
如果输出 Resolved version: v2 就说明通了。如果仍是 None,90% 是 header 格式或空格问题。

真正容易被忽略的是:header 版本控制完全依赖客户端配合,服务端无法“强制”客户端发正确头;一旦前端 SDK 或网关层改写 Accept,整个版本路由就失效 —— 所以生产环境建议搭配日志监控 request.version is None 的请求比例。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1651

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4024

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1629

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

23217

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2847

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2887

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1143

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2243

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Django 6.1 官方文档
Django 6.1 官方文档

共0课时 | 0人学习

Django 教程
Django 教程

共28课时 | 9.7万人学习

Django DRF 源码解析
Django DRF 源码解析

共21课时 | 2万人学习