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

Yii2的API接口怎么实现快速开发_使用RESTful模块创建接口【指南】

雨涛吖_9719

雨涛吖_9719

发布时间:2026-03-11 16:36:13

|

344人浏览过

|

来源于php中文网

原创

继承 yii\rest\ActiveController 可快速搭建 REST 接口,自动支持 index/view/create/update/delete 五个动作;需正确配置 modelClass、启用复数化路由、处理 OPTIONS 预检请求、自定义序列化字段及启用 JSON 解析器。

yii2的api接口怎么实现快速开发_使用restful模块创建接口【指南】

怎么用 yii\rest\ActiveController 快速搭出一个可用接口

直接继承 yii\rest\ActiveController 是最快路径,它自动绑定 index、view、create、update、delete 五个动作,只要模型有 ActiveRecord 基础,几乎不用写逻辑。

常见错误是没配好 modelClass 或忘了在 URL 规则里加 pluralize —— 比如模型叫 User,默认路由会期待 /users 而不是 /user,不匹配就 404。

  • 控制器里必须设置 public $modelClass = 'app\models\User';
  • URL 管理配置中要启用复数化:'enablePrettyUrl' => true + 'showScriptName' => false,并确保 urlManager 的 rules 包含 ['class' => 'yii\rest\UrlRule', 'controller' => 'user']
  • 如果模型主键不是 id(比如是 uid),得重写 findModel() 方法,否则 GET /users/123 会查不到

为什么 OPTIONS 请求返回 404 或跨域失败

Yii2 默认不自动处理预检请求(OPTIONS),前端发带 Authorization 或自定义 header 的请求时,浏览器先发 OPTIONS,没响应就直接拦掉。

这不是 CORS 配置没开的问题,而是路由根本没匹配到。RESTful 模块不会为每个动作自动注册 OPTIONS 处理器。

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载
  • 在控制器里显式声明支持的方法:public $verbs = ['index' => ['GET', 'HEAD', 'OPTIONS']]
  • 或者全局加中间件:在 config/web.php 的 as cors 配置里,确保 'Access-Control-Allow-Methods' => 'GET, POST, PUT, DELETE, OPTIONS'
  • 注意 nginx/Apache 是否拦截了 OPTIONS 请求——有些服务器配置会直接返回 405,得显式放行

yii\rest\Serializer 返回字段怎么精简或扩展

默认序列化只输出模型的 attributes(),但实际接口常要隐藏敏感字段(如 password_hash)、加计算字段(如 full_name)或嵌套关联数据(如用户所属部门)。

别在控制器里手动拼数组,那会绕过序列化流程,丢失分页、状态码等 RESTful 特性。

  • 重写模型的 fields() 方法,用 unset($array['password_hash']) 剔除字段
  • 在 fields() 里加虚拟字段:'full_name' => function ($model) { return $model->first_name . ' ' . $model->last_name; }
  • 关联数据用 extraFields() + expand 参数实现按需加载,比如 ?expand=department,避免 N+1

POST/PUT 提交 JSON 数据却拿不到参数

Yii2 默认只从 $_POST 和 application/x-www-form-urlencoded 解析请求体,前端用 fetch 发 Content-Type: application/json 时,Yii::$app->request->post() 是空的。

这不是前端问题,也不是没写 Yii::$app->request->getBodyParams() —— 而是没启用 JSON 输入解析器。

  • 在应用配置 components['request'] 里加:'parsers' => ['application/json' => 'yii\web\JsonParser']
  • 确保请求头真正是 Content-Type: application/json,有些前端库(比如 axios)默认不设,得手动指定
  • 如果用了 Yii::$app->request->getBodyParam('name'),它底层会自动调用解析器;但 post() 不会,别混用
接口能跑通不难,难的是默认行为和你直觉不一致的地方——比如复数路由、JSON 解析开关、字段序列化边界、预检请求的显式声明。这些点漏一个,调试时间翻倍。

热门AI工具

更多
墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

讯飞绘文

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

Laper
Laper Hot

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

DeepSeek

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

豆包大模型

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

PixPix
PixPix Hot

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

WorkBuddy

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

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

423

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3787

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

6565

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

581

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1496

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3978

2024.08.07

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

122

2026.01.13

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

517

2026.01.13

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

60

2026.10.22

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共22课时 | 9.3万人学习

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

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