Yii框架RESTful接口怎么获取Format_Yii框架响应格式协商【方法】

小辰小哥_4183

小辰小哥_4183

2026-04-25

733人浏览

原创

yii2 restful接口通过contentnegotiator行为控制响应格式,依据accept请求头与formats配置匹配;强制json需覆盖formats为['application/json'=>response::format_json,'/'=>response::format_json],并确保使用yii\rest\controller及其子类。

yii框架restful接口怎么获取format_yii框架响应格式协商【方法】

Yii2 RESTful 接口如何控制响应格式(JSON/XML)

Yii2 的 RESTful 接口默认支持 JSON 和 XML 两种格式,但实际返回哪种,取决于客户端 Accept 请求头 + 服务端 ContentNegotiator 配置的共同作用。不显式干预时,它会按 q 权重匹配,但多数 API 场景下你只想返回 JSON —— 这时不能靠“客户端发什么就回什么”,而要强制协商结果。

修改 ContentNegotiator::formats 强制只输出 JSON

最直接有效的方式是在控制器的 behaviors() 中覆盖默认协商规则。注意:不是改 Response::format,而是改 contentNegotiator 行为里的 formats 映射表。

  • formats 的 key 是 MIME 类型(如 'application/json'),value 是 Yii 内置的格式常量(如 Response::FORMAT_JSON)
  • 把不需要的格式(比如 'text/html'、'application/xml')映射到 Response::FORMAT_JSON,等效于“全部转 JSON”
  • 如果只留 ['application/json' => Response::FORMAT_JSON],客户端发 Accept: application/xml 会直接 406 Not Acceptable

示例(在 UserController.php 中):

public function behaviors()
{
    $behaviors = parent::behaviors();
    $behaviors['contentNegotiator']['formats'] = [
        'application/json' => Response::FORMAT_JSON,
        'text/html' => Response::FORMAT_JSON,
    ];
    return $behaviors;
}

全局统一设为 JSON(适用于纯 API 项目)

如果你的整个应用就是后端 API(比如面向 App 或前端 SPA),没必要每个控制器都写一遍。直接在 config/web.php 的 as contentNegotiator 全局行为里配置,更干净。

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载
  • 必须放在 as 数组中,且需确保它在所有控制器 action 执行前生效
  • 不要漏掉 '*/*' 这个兜底 MIME,否则某些没带 Accept 头的请求可能失败
  • 全局设置后,ActiveController 自带的 contentNegotiator 会被覆盖,无需再在控制器里重复配置

配置片段(config/web.php):

'as contentNegotiator' => [
    'class' => 'yii\filters\ContentNegotiator',
    'formats' => [
        'application/json' => Response::FORMAT_JSON,
        '*/*' => Response::FORMAT_JSON,
    ],
],

为什么有时改了 formats 还返回 XML?

常见原因不是配置错,而是中间环节干扰了协商流程:

  • 你在控制器里手动调用了 $this->response->format = Response::FORMAT_XML,这会直接覆盖协商结果
  • 自定义的 Serializer 或 Response 子类在 prepare() 里硬编码了 Content-Type 头
  • urlManager 规则里启用了 suffix(如 'suffix' => '.xml'),Yii 会优先按后缀判断格式,绕过 Accept 头
  • 你用的是 yii\web\Controller 而非 yii\rest\ActiveController,后者才默认注入 contentNegotiator 行为

最稳妥的验证方式:用 curl -H "Accept: application/xml" http://localhost/users 测试,看响应头 Content-Type 是什么 —— 别只看返回体是否像 JSON。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

yii框架 yii

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

相关专题

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

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

2025.11.26

544

16

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

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

2023.07.31

1729

3

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

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

2024.06.27

1211

7

PHP Yii框架专题
PHP Yii框架专题

本专题专注于PHP主流框架Yii的应用,系统讲解MVC架构、路由机制、数据库操作、表单处理、安全验证与RESTful API 开发等核心内容。通过电商网站、后台管理系统与内容管理平台等实战项目,帮助学员快速掌握Yii框架的开发技巧与实战经验。

2025.09.04

3030

22

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

60

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

40

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

40

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

20

15

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

2026.10.16

20

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习