Yii2的RESTful版本控制_自定义MediaType和版本路由【方法】

秋墨姑娘_4469

秋墨姑娘_4469

2026-03-24

149人浏览

原创

yii2 restful 中 accept 头生效需显式配置 contentnegotiator 行为,启用 acceptheader、清空 formats、注册自定义 media type 到 response.formatters,并统一在 beforeaction 中按 url 版本 > accept 头 > 默认版本的优先级解析版本。

yii2的restful版本控制_自定义mediatype和版本路由【方法】

Yii2 RESTful 里怎么让 Accept 头真正生效?

Yii2 默认不校验 Accept 头,哪怕你传了 application/vnd.myapp.v2+json,它照样走默认版本。关键在 ContentNegotiator 行为没配对,或者配了但没启用 acceptHeader 模式。

  • 必须在控制器里显式挂载 ContentNegotiator 行为,并设 'formats' => [](清空默认格式映射),否则 Yii 会优先按后缀(如 .json)匹配,忽略 Accept
  • acceptHeader 要设为 true,且 formatParam 别和 acceptHeader 冲突——比如同时开了 formatParam(如 format=json),请求带 Accept 反而会被覆盖
  • 自定义 media type 必须注册到 Response::formatters,否则即使头匹配了,JsonResponseFormatter 也认不出你的 vnd.myapp.v2+json

怎么注册自定义 MediaType(比如 vnd.myapp.v2+json)?

Yii2 的 Response 不认识你造的 media type,得手动告诉它:这个 type 对应哪个 formatter、用什么 mime 类型解析。

  • 在 config/web.php 或应用启动时,往 response.formatters 加一项:'application/vnd.myapp.v2+json' => 'yii\web\JsonResponseFormatter'
  • 别漏掉 response.format = 'json',否则 formatter 不会触发;如果要支持多版本差异化序列化,得自己写子类继承 JsonResponseFormatter,重写 format 方法判断 $response->getHeaders()->get('Accept')
  • 注意 mime type 字符串必须完全一致——vnd.myapp.v2+json 和 vnd.myapp.v2+json; charset=UTF-8 是两个不同 type,后者不会命中注册项

路由层怎么按版本分发请求(比如 /api/v2/users)?

单纯靠 URL 路径分版本最直接,但容易和 Accept 头逻辑打架。Yii2 的 UrlRule 支持正则捕获,可把版本号转成参数透传给控制器。

Yii Framework 2.0.51
Yii Framework 2.0.51

Yii Framework 2.0.51 官方 Basic 应用模板,适合旧项目兼容、升级验证和开发测试。

下载
  • 在 urlManager.rules 里加一条:'pattern' => 'api/v<code>version:\d+/', 'route' => 'api/', 'defaults' => ['version' => '1']
  • 控制器里通过 $this->module->params['version'] 或 Yii::$app->request->get('version') 拿版本号,再决定调用哪个 service 层或 serializer
  • 别在路由规则里硬编码 v1/v2 多条规则——维护成本高,且无法 fallback;用正则捕获 + 默认值更灵活

Accept 头和 URL 版本同时存在时,以谁为准?

没有默认规则,全靠你自己定优先级。实际项目中建议明确约定:URL 路径版本 > Accept 头 > 默认版本。否则前端传错头、后端又没校验,很容易出现 v2 接口返回 v1 数据这种静默错误。

  • 在 beforeAction() 里统一提取版本信息:先从路由参数取 version,有则直接用;没有再 parse Accept 头;都无则 fallback
  • 特别注意 Accept 头可能带多个 type,如 Accept: application/vnd.myapp.v2+json, application/json,要用 yii\web\AcceptHeaderParser 解析权重,别简单 strpos 匹配
  • 版本号建议只接受数字(\d+),拒绝 v2.1 或 beta 这类非规范值——避免后续兼容性爆炸

版本控制最难的不是怎么写,而是所有入口(路由、头、参数、甚至 query string)都要收敛到同一个版本决策点,漏一个就可能绕过版本逻辑。别信“只要 Accept 头对就行”这种直觉。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

yii

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

2025.11.26

544

16

json数据格式
json数据格式

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

2023.08.07

2135

5

json是什么
json是什么

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

2023.08.23

3302

1

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

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

2023.10.13

1116

3

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

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

2025.09.10

3759

7

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.02

6439

3

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

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

2023.07.31

1749

3

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.06.27

1211

7

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1758

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习

Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习