Yii框架RESTful接口怎么路由_Yii框架UrlRule规则详解【解答】

夜墨酱_1244

夜墨酱_1244

2026-04-21

291人浏览

原创

yii\rest\UrlRule生效需三要素:启用enablePrettyUrl、urlManager挂载为组件、控制器继承yii\rest\ActiveController;缺一不可。

yii框架restful接口怎么路由_yii框架urlrule规则详解【解答】

yii\rest\UrlRule 怎么配才生效

不生效的常见原因是:没启用 enablePrettyUrl,或 urlManager 没挂到应用组件里,或控制器没继承 yii\rest\ActiveController。这三处缺一不可。

必须在 config/web.php 的 components['urlManager'] 中设置:

  • enablePrettyUrl 为 true
  • enableStrictParsing 建议设为 true(避免模糊匹配导致路由错乱)
  • showScriptName 设为 false(隐藏 index.php)
  • rules 数组中加入 ['class' => 'yii\rest\UrlRule', 'controller' => ['v1/user']]

注意:controller 值是数组,即使只配一个控制器也要写成 ['v1/user'],不是字符串 'v1/user';否则会报 Invalid Configuration – yii\base\InvalidConfigException。

pluralize=false 时 URL 和动作怎么对应

默认 pluralize=true,GET /users 映射到 actionIndex,GET /users/123 映射到 actionView。设为 false 后,资源名变单数,但动作映射逻辑不变——只是 URL 看起来更“精简”,不代表语义更准确。

配置示例:

['class' => 'yii\rest\UrlRule', 'controller' => 'user', 'pluralize' => false]

此时:

  • GET /user → actionIndex
  • GET /user/123 → actionView
  • POST /user → actionCreate

⚠️ 容易踩的坑:前端调用时仍按复数习惯写 /users,后端却配了 pluralize=false,结果 404;建议团队统一约定并写进接口文档,别靠“猜”。

extraPatterns 能加哪些自定义动作

extraPatterns 是给 RESTful 默认动作之外补路由的,比如要加一个批量删除、导出 Excel、或软删除标记,就不能靠 actionIndex 或 actionUpdate 覆盖,得显式声明。

写法是键为 HTTP 方法 + 路径模式,值为动作名:

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

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

下载
['class' => 'yii\rest\UrlRule', 'controller' => 'user', 'extraPatterns' => [
    'DELETE batch' => 'batch-delete',
    'GET export' => 'export',
]]

对应控制器里就得有 actionBatchDelete() 和 actionExport() 方法。注意路径里的空格不能省——'DELETE batch' 是固定格式,不是正则。

常见错误:

  • 写成 'delete batch'(方法名必须大写)
  • 动作名拼错,如 'batch_delete'(Yii 不会自动转驼峰,必须严格匹配 actionXxx)
  • 漏掉 public 访问修饰符,导致 403 或静默失败

URL 版本号怎么透传到控制器里用

单纯把 v1 写死在 controller 键里(如 'v1/user')只能做模块隔离,没法在同一个控制器里动态响应不同版本逻辑。真要支持多版本共存,得靠路由参数捕获 + 控制器内解析。

推荐做法是在 urlManager 规则中用正则提取版本号:

['class' => 'yii\rest\UrlRule', 'controller' => 'user', 'prefix' => 'api', 'pattern' => '<v1>/<controller:>', 'route' => '<controller>']</controller></controller:></v1>

这样 GET /api/v2/users 会把 version 当作请求参数注入,控制器里可用 Yii::$app->request->get('version') 拿到。

关键点:

  • 别依赖 $_GET['version'],要用 Yii 的 request 组件,它已做过滤和类型转换
  • 如果同时支持 URL 版本和 Accept 头,优先级必须手动在 beforeAction() 里定清楚,Yii 不自动处理冲突
  • 版本参数未提供时,务必设默认值(如 Yii::$app->request->get('version', 'v1')),否则可能触发空指针或 500

最常被忽略的是:路由规则里写了 prefix 或 pattern,但忘了在 rules 数组里把它放在普通规则前面——因为 urlManager 是顺序匹配,靠后的规则可能永远不被执行。

相关文章

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

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

下载

相关标签:

yii框架 yii 路由

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

12644

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

7261

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2235

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4588

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

5294

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

4171

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

6037

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4742

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12502

4

热门下载

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

精品课程

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

共22课时 | 9.3万人学习

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

共0课时 | 0人学习