yii rest路由必须显式指定'class' => 'yii\rest\urlrule',否则controller配置无效;需启用enableprettyurl和enablestrictparsing,并确保控制器继承activecontroller、modelclass正确、extrapatterns格式规范。

yii\rest\UrlRule 必须显式声明 class
直接在 rules 数组里写 ['controller' => 'user'] 是无效的——这会被当成普通数组规则,完全忽略 extraPatterns 和 REST 动词映射。必须明确指定 'class' => 'yii\rest\UrlRule',否则 POST /users 会 fallback 到默认路由或 404。
常见错误配置:
['controller' => 'user'] // ❌ 没有 class,不生效
正确写法:
['class' => 'yii\rest\UrlRule', 'controller' => 'user'] // ✅
如果控制器在模块下(如 api/v1),controller 值要带模块前缀:'api/v1/user',且确保该控制器类真实存在、命名空间正确。
enablePrettyUrl 和 enableStrictParsing 缺一不可
enablePrettyUrl => true 和 enableStrictParsing => true 不是可选项,而是 REST 路由生效的前提。前者让 /users 这类路径能被解析;后者强制所有请求必须匹配某条规则,避免静默 fallback 到 site/index 导致“看似能访问,实则没走 REST 流程”。
容易漏掉的点:
-
showScriptName => false必须同步设为false,否则/index.php/users可能意外通过,但前端调用时路径不一致 - Apache 用户需确认
.htaccess存在且RewriteEngine On已启用;Nginx 用户必须有try_files $uri $uri/ /index.php?$args; - 配置改完后,清空
runtimes/cache/下的路由缓存,否则旧规则仍生效
controller 参数必须与类名严格对应
'controller' => 'user' 对应的是 UserController 类,且该类必须:
- 继承
yii\rest\ActiveController - 声明
public $modelClass = 'app\models\User';(完整命名空间,不能省略app\或写成User::class) -
$modelClass所指模型必须继承yii\db\ActiveRecord
典型报错 Unknown Method – yii\base\UnknownMethodException: Calling unknown method: app\controllers\UserController::actions(),基本就是继承错了基类,或命名空间拼写错误(比如写成 yii\rest\Controller)。
自定义动作要配 extraPatterns 且格式敏感
想加 POST /users/123/activate 这种动作,不能只写 'POST activate' => 'activate',必须:
- 用
extraPatterns键,不是patterns - 键名是
'POST activate'(大写 HTTP 方法 + 一个空格 + 动作名),'post activate'或'POST/activate'都不识别 - 若路径含 ID,
pattern必须显式包含占位符:'pattern' => 'users/<id:>/activate'</id:>,否则该动作不会注入到带 ID 的路由中 - 整个规则要写成数组形式,不能混在字符串规则里
示例:
['class' => 'yii\rest\UrlRule', 'controller' => 'user', 'extraPatterns' => ['POST activate' => 'activate']] // 仅支持 /users/activate
['class' => 'yii\rest\UrlRule', 'controller' => 'user', 'pattern' => 'users/<id:>/activate', 'route' => 'user/activate', 'extraPatterns' => ['POST activate' => 'activate']] // 支持 /users/123/activate</id:>
最常被忽略的是:没写 pattern 却指望 extraPatterns 自动适配所有变体路径——它不会。











