Yii框架RESTful接口怎么设计_Yii框架API路由规则配置【教程】

老伟小哥_2399

老伟小哥_2399

2026-04-21

946人浏览

原创

yii restful接口依赖yii\rest\urlrule与yii\rest\activecontroller自动映射,需正确配置urlmanager(enableprettyurl和enablestrictparsing必须为true)、控制器继承activecontroller并声明$modelclass、web服务器重写规则生效,且urlrule中controller参数须与控制器类名严格匹配。

yii框架restful接口怎么设计_yii框架api路由规则配置【教程】

直接说结论:Yii 的 RESTful 接口不是靠“手写一堆 action”堆出来的,而是靠 yii\rest\UrlRule + yii\rest\ActiveController 自动映射 HTTP 动词和资源路径,路由规则配错、控制器没继承对、URL 重写没生效——这三处任一出问题,GET /users 就会 404 或返回 HTML 页面。

urlManager 配置必须启用 enablePrettyUrl 和 enableStrictParsing

很多人只加了 rules 却漏掉基础开关,结果请求被 fallback 到默认路由(比如跳到 site/index),看似“能访问”,实则没走 REST 流程。

  • enablePrettyUrl => true:关闭 index.php?r=xxx 这种丑 URL,是 REST 路径的前提
  • enableStrictParsing => true:强制所有请求必须匹配 rules 中的某条,否则 404 —— 这能帮你快速发现规则没覆盖到的路径
  • showScriptName => false:隐藏 index.php,否则 /index.php/users 也能访问,但不符合 REST 美学,且容易在前端或网关层出错

错误示例:'enablePrettyUrl' => false 时,curl -X GET http://api/users 会 404;正确配置后,才可能触发 yii\rest\UrlRule 的自动解析。

控制器必须继承 yii\rest\ActiveController 并声明 $modelClass

写个普通 Controller 然后自己写 actionIndex()、actionCreate() 是无效的——那只是传统 Web 控制器,不会响应 POST /users 这类请求。

Skill Weave Chains — 技能链路由引擎
Skill Weave Chains — 技能链路由引擎

开箱即用的技能链路由引擎。13 条预定义链覆盖搜索、开发、审查、MLOps、法律、创意等场景,三层路由架构(触发词→SAD反馈→DAG编排),recall@10=96.97%。配置驱动(chains.yaml),零代码扩展。pip install skill-weave-chains 一键安装。

下载
  • 必须用 class UserController extends \yii\rest\ActiveController
  • 必须设置 public $modelClass = 'app\models\User';,且该模型要继承 yii\db\ActiveRecord
  • 不要重写 actions(),除非你明确想禁用某个动作(如屏蔽 DELETE);默认它已内置 index(GET /users)、view(GET /users/1)、create(POST /users)等

常见报错:Unknown Method – yii\base\UnknownMethodException: Calling unknown method: app\controllers\UserController::actions(),说明你继承错了基类,或者命名空间拼错。

Web 服务器 rewrite 规则没配好,/users 根本进不了 Yii

即使 PHP 层一切正确,Apache 或 Nginx 没把请求转发给 index.php,/users 就永远 404 或返回 403/404 文件系统错误。

  • Apache:确保 frontend/web/.htaccess 存在且内容正确,且服务器允许 AllowOverride All
  • Nginx:在 location / 块里必须有 try_files $uri $uri/ /index.php$is_args$args;,缺 $is_args$args 会导致带查询参数的请求(如 /users?page=2)丢失参数
  • 测试方法:直接访问 http://your-domain/index.php/users,如果能返回 JSON 数据,说明 PHP 层 OK,问题一定出在 rewrite 上

UrlRule 的 controller 参数值必须和控制器类名匹配

yii\rest\UrlRule 不是从文件名推导控制器,而是靠字符串映射。写错大小写、漏掉命名空间前缀、多加斜杠,都会导致找不到控制器。

  • 控制器文件路径是 controllers/UserController.php,类名为 app\controllers\UserController,那么 rule 里必须写 'controller' => 'user'(小写,无 Controller 后缀)
  • 如果是模块内控制器,比如 api\modules\v1\controllers\UserController,rule 应为 'controller' => ['v1/user'],不是 'v1/usercontroller' 或 'v1/User'
  • 多个控制器可合并写: 'controller' => ['user', 'post', 'comment'],每条自动生成 7~8 个标准路由

最容易被忽略的是:yii\rest\UrlRule 默认不处理 OPTIONS 预检请求,如果你的前端跨域发 PUT/PATCH/DELETE,需要额外加 'extraPatterns' => ['OPTIONS' => 'options'],否则浏览器会卡在预检失败。

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

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

yii框架 yii 路由

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

相关专题

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

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

2025.11.26

544

16

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

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

2025.09.04

3050

22

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

2026.10.21

20

15

Playwright 页面操作指南
Playwright 页面操作指南

Playwright页面操作专题汇集元素定位、点击与输入、等待响应、多页面切换、Iframe、事件监听及文件处理的已审核文章,便于按操作场景查阅示例与常见问题。

2026.10.21

0

16

Playwright 入门教程
Playwright 入门教程

Playwright入门专题汇集测试框架安装、VS Code配置、录制脚本、编写首个用例、运行调试及查看报告的已审核文章,帮助初学者搭建端到端测试流程。

2026.10.21

0

16

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

120

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

80

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

60

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

40

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习