Yii 框架 RESTful API 数据访问规范【接口】

千伟同学_4926

千伟同学_4926

2026-08-07

151人浏览

原创

要使yii restful api正确响应请求,需确保user模型继承activerecord、实现tablename()与rules()、屏蔽敏感字段、预加载关联数据;否则将出现查询错误、安全漏洞或n+1问题。

yii 框架 restful api 数据访问规范【接口】

要让 Yii 框架 RESTful API 正确响应 GET /users、GET /users/1 等请求并返回结构化数据,必须确保模型层能被控制器准确调用、字段验证逻辑生效、关联关系可序列化,且数据库查询不暴露敏感字段或触发 N+1 问题。

模型类必须继承 ActiveRecord 并定义 tableName()

控制器通过 $modelClass 反射实例化模型,若模型未继承 yii\db\ActiveRecord 或未声明表名,ActiveController 在执行 find() 或 findOne() 时会直接抛出错误或返回空结果。

在 api\models\User.php 中写入:

class User extends \yii\db\ActiveRecord
{
    public static function tableName()
    {
        return 'user';
    }
}

【tableName() 返回值必须与数据库真实表名完全一致,大小写敏感】

必须实现 rules() 方法并启用验证

Yii RESTful 接口默认不强制校验输入,但 POST/PUT 请求若携带非法字段(如 id、status=999),而模型 rules() 返回空数组,数据将直接写入数据库,导致安全漏洞或状态错乱。

第一步:在 User 模型中补全 rules():

public function rules()
{
    return [
        [['name', 'email'], 'required'],
        ['email', 'email'],
        [['status'], 'in', 'range' => [0, 1]],
    ];
}

第二步:在 UserController 中显式启用验证行为(否则即使 rules 存在也不生效):

public function behaviors()
{
    $behaviors = parent::behaviors();
    $behaviors['verbs'] = [
        'class' => \yii\rest\VerbFilter::className(),
        'actions' => [
            'create' => ['POST'],
            'update' => ['PUT', 'PATCH'],
        ],
    ];
    $behaviors['contentNegotiator']['formats']['text/html'] = \yii\web\Response::FORMAT_JSON;
    return $behaviors;
}

这一步不做,POST 请求即使字段缺失也不会报 422,而是静默插入 NULL 或默认值。

敏感字段需主动屏蔽

默认情况下,ActiveController 会把模型所有 public 属性转为 JSON 输出,password_hash、api_token、deleted_at 等字段一旦泄露,系统即失守。

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载

方法一:重写 fields() 方法(推荐)

public function fields()
{
    $fields = parent::fields();
    unset($fields['password_hash'], $fields['api_token']);
    return $fields;
}

方法二:使用 scenarios() + safe 标记(适用于不同接口版本差异化输出)

public function scenarios()
{
    $scenarios = parent::scenarios();
    $scenarios['api-list'] = ['id', 'name', 'email', 'created_at'];
    return $scenarios;
}

然后在控制器中设置:

public $serializer = [
    'class' => \yii\rest\Serializer::className(),
    'collectionEnvelope' => 'items',
];

并在 actionIndex() 中手动指定场景:
$models = User::find()->asArray()->all();
return new \yii\data\ArrayDataProvider(['allModels' => $models]);
——这种写法绕过模型序列化,需自行控制字段。

关联数据必须用 with() 预加载

若 User 模型有 getProfile() 关联方法,而控制器未预加载,访问 /users/1 时 ActiveController 默认只查主表,后续序列化中调用 $model->profile 会触发额外 SQL 查询,一个请求可能发起 50+ 次 DB 查询。

在 UserController 的 findModel() 方法中覆盖默认逻辑:

protected function findModel($id)
{
    $model = User::find()
        ->with('profile', 'roles')
        ->where(['id' => $id])
        ->one();
    if ($model === null) {
        throw new \yii\web\HttpException(404, 'The requested Item does not exist.');
    }
    return $model;
}

注意:with() 中的关联名必须与模型里定义的 getter 方法名完全一致(如 getProfile() → 'profile'),拼错则静默忽略,仍会 N+1。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

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

相关专题

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

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

2025.11.26

524

16

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

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

40

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

40

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

60

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

280

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

160

15

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共22课时 | 9.3万人学习