Yii2rest控制器表单验证JSON返回配置

雨浩姑娘_9299

雨浩姑娘_9299

2026-08-19

205人浏览

原创

yii2 rest控制器需继承yii\rest\controller或activecontroller,配置jsonparser解析器并使用bodyparams加载数据,验证失败时自动返回json错误;通过response组件on beforesend统一错误结构,确保content-type与accept头协同。

yii2rest控制器表单验证json返回配置

Yii2 REST 控制器中表单验证失败时返回 JSON,关键不是“手动拼数组”,而是让整个验证流程自然落入框架的 JSON 响应链——从请求解析、验证触发、错误收集,到最终序列化输出,每一步都要对齐 REST 规范。

确保请求体能被正确解析为 PHP 数组

如果前端用 application/json 提交数据(如 {"username":"a","password":"123"}),但控制器里 $model->load(Yii::$app->request->post()) 始终为空,说明 JSON 解析器没启用:

  • 在 config/web.php 的 components['request'] 中必须配置:
    'parsers' => ['application/json' => 'yii\web\JsonParser']
  • 验证时改用 $model->load(Yii::$app->request->bodyParams, ''),因为 JSON 数据会自动注入 bodyParams,而非 post()
  • 不配解析器,$model->validate() 会因属性未赋值而“验证通过”,实际漏校验

让验证错误自动走 JSON 流程

继承 yii\rest\Controller 或 yii\rest\ActiveController 是前提。只有这类控制器才会在验证失败时自动触发 beforeAction → response->data = $model->errors → 经由 Serializer 序列化为 JSON:

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载
  • 若用普通 yii\web\Controller,即使设了 response->format = FORMAT_JSON,错误也不会自动转成 {"username":["Username cannot be blank."]},得自己写 if (!$model->validate()) { return $model->errors; }
  • ActiveController 的 createAction 和 updateAction 已内置验证失败返回逻辑,无需重写
  • 自定义动作中,统一用 if (!$model->validate()) { return $model->errors; } 即可,框架会将其作为 response->data 正常 JSON 化

统一错误结构(含验证错误)

默认返回的 $model->errors 是扁平数组,如 {"username":["..."]},但业务常需包一层 {"code":400,"message":"Validation failed","errors":{...}}。推荐在 config/web.php 的 response 组件中用 on beforeSend 拦截:

  • 只处理 FORMAT_JSON 且 is_array($response->data) 的响应,避免干扰文件下载等场景
  • 判断 $response->statusCode >= 400 时,将原 $response->data 移入 errors 字段,同时补 code 和 message
  • 这样无论是模型验证失败(422)、路由不存在(404)还是权限不足(403),都保持同一壳结构

注意 Content-Type 与 Accept 头协同

浏览器直接访问 POST 接口或 Postman 未设头时,可能返回 HTML 错误页,而非 JSON:

  • 测试务必带上 -H "Accept: application/json",否则 ContentNegotiator 可能 fallback 到 HTML
  • 内部系统可强制协商:在控制器 behaviors() 中覆盖 contentNegotiator,添加 'text/html' => Response::FORMAT_JSON
  • 但不要删掉 'application/json' => Response::FORMAT_JSON,否则标准 API 客户端会失效

相关文章

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

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

下载

相关标签:

js json yii2 yii

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

相关专题

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

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

2025.11.26

524

16

json数据格式
json数据格式

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

2023.08.07

2015

5

json是什么
json是什么

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

2023.08.23

2922

1

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

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

2023.10.13

996

3

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

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

2025.09.10

3299

7

ThinkPHP表单验证与数据安全处理实战
ThinkPHP表单验证与数据安全处理实战

本专题聚焦 ThinkPHP 在表单处理中的验证与安全机制,系统讲解验证器使用、自定义规则、场景验证以及错误提示处理。内容涵盖 XSS 防护、SQL 注入防御、数据过滤与输入校验等关键安全措施。通过实际案例,帮助开发者构建安全可靠的数据处理流程。

2026.03.30

201

20

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

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

2025.09.04

2910

22

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

80

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

80

14

热门下载

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

精品课程

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

共101课时 | 20.8万人学习

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

共39课时 | 4.8万人学习