讲师中心 微信公众号
AI工具推荐 视频效率加速

Yii3.0 响应式API配置教程【JSON】

云静姑娘_6004

云静姑娘_6004

发布时间:2026-08-08 21:13:02

|

656人浏览过

|

来源于php中文网

原创

必须使用 yii estController 或其子类,配置 UrlRule 启用严格解析,设置 JsonParser 解析器,并统一响应格式为 JSON,四者缺一不可;否则将出现空响应、text/html 头、406 错误或 POST body 解析失败。

yii3.0 响应式api配置教程【json】

要让 Yii3.0 的 API 接口稳定返回 JSON 数据,不能依赖自动协商或全局行为——必须明确控制器类型、响应格式、序列化器和请求解析器四者协同生效;漏掉任一环节,就会出现空响应、text/html 头、406 错误或 POST body 解析失败。

控制器必须继承 yii estController 或其子类

普通 yiiaseController 会触发视图渲染,导致 JSON 响应混入 HTML 模板或直接崩溃。【必须用 rest 控制器】

创建控制器时,使用命令行生成并手动修改基类:

php yii g/controller User --base-class=\yii\rest\Controller

打开生成的 controllers/UserController.php,确认 class 声明为:
class UserController extends yii estController

若需自动 CRUD(如 GET /users、POST /users),改用 yii estActiveController,并声明 public $modelClass = 'appmodelsUser'; ——否则 index/view 等动作不会注册。

配置 URL 路由规则启用 REST 自动映射

Yii3 不再默认启用 REST 路由,必须显式注册 UrlRule 并开启严格解析。

在 config/web.php 的 components['urlManager']['rules'] 中添加:

'class' => yii estUrlRule::class,
'controller' => ['v1/user'],
'pluralize' => true

同时确保 urlManager 启用关键开关:
enablePrettyUrl => true,
enableStrictParsing => true,
showScriptName => false

【enableStrictParsing 必须为 true】,否则未匹配路径将 fallback 到 site/index,返回 HTML 而非 404 JSON 错误。

设置请求体解析器支持 JSON 输入

前端发来的 {"name":"test"} 放在 request body 里,默认无法通过 $request->post() 获取——因为 Yii3 不自动解析 application/json 类型的原始 body。

第一步:在 config/web.php 的 components['request'] 中添加 parsers 配置:

'parsers' => [
  'application/json' => yiiwebJsonParser::class,
],

wechat-article-extraction-mp-weixin-qq-com news-webpage-cleaning blog-post-parsing metadata-extraction-title-author-date multiple-output-formats-markdown-json-plain-text batch-processing-support
wechat-article-extraction-mp-weixin-qq-com news-webpage-cleaning blog-post-parsing metadata-extraction-title-author-date multiple-output-formats-markdown-json-plain-text batch-processing-support

基于三引擎设计,从微信文章、新闻和博客网页提取干净内容,支持标题作者日期元数据,多格式和批量处理。

下载

第二步:确保控制器动作中使用 $request->getBodyParams() 而非 $_POST 或 $request->post() —— 后两者只处理表单编码数据。

第三步:若使用 ActiveController,它内部已调用 getBodyParams(),无需额外改动;但自定义 action 中必须显式调用。

强制统一 JSON 响应格式(含错误)

Yii3 默认仅对 Accept: application/json 请求返回 JSON,而 Postman/curl 默认不带该头,导致 500 错误仍返回 HTML。

方法一:在入口文件 web/index.php 中,于 Application 实例 run() 前插入:

Yii::$app->on(yiiaseApplication::EVENT_BEFORE_REQUEST, function ($event) {
  if (str_contains(Yii::$app->request->getContentType(), 'application/json') || Yii::$app->request->isAjax) {
    Yii::$app->response->format = yiiwebResponse::FORMAT_JSON;
  }
});

方法二(推荐):为 API 模块单独配置 errorHandler 组件,在模块 config 中写:

'errorHandler' => [
  'errorAction' => 'v1/error',
],

然后在 controllers/v1/ErrorController.php 中,actionError() 直接 return ['code' => $exception->getCode(), 'message' => $exception->getMessage()] —— 此时 response format 已由 beforeRequest 设定,无需重复设 format。

注意:不要在 actionError 里调用 $this->render() 或 echo,这会破坏 JSON 流程。

验证响应头与内容是否正确

用 curl 测试,必须带 -H "Accept: application/json" 和 -H "Content-Type: application/json":

curl -X GET http://localhost/users -H "Accept: application/json"

查看响应头是否含 Content-Type: application/json;若返回 HTML,说明 UrlRule 未生效或控制器基类错误。

用浏览器直接访问 /users 会返回 406 —— 这是正常行为,证明 content negotiation 已启用;若返回 HTML 页面,则说明 enableStrictParsing = false 或路由未命中。

检查 runtime/logs/app.log,搜索 "Invalid JsonParser" 或 "No matching route" 可快速定位解析或路由问题。

热门AI工具

更多
Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

4156

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1295

2023.07.28

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

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

1678

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

9703

2023.08.17

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

940

2023.09.01

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2544

2023.09.04

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

1509

2023.09.14

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

4349

2023.09.21

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

热门下载

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

精品课程

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

共101课时 | 20.9万人学习

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

共39课时 | 4.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn