0

0

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

看不見的法師

看不見的法師

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

|

324人浏览过

|

来源于php中文网

原创

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

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

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

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

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

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

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

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

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

星月写作
星月写作

专为网络小说、 剧本创作者打造的AI增效工具

下载
  • 在控制器里显式声明支持的方法:public $verbs = ['index' => ['GET', 'HEAD', 'OPTIONS']]
  • 或者全局加中间件:在 config/web.phpas 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 默认只从 $_POSTapplication/x-www-form-urlencoded 解析请求体,前端用 fetchContent-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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
nginx 重启
nginx 重启

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

246

2023.07.27

nginx 配置详解
nginx 配置详解

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

522

2023.08.04

nginx配置详解
nginx配置详解

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

610

2023.08.04

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

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

244

2024.02.23

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

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

693

2024.07.09

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

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

3618

2024.08.07

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

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

54

2026.01.13

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

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

71

2026.01.13

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号