Yii框架RESTful接口URL美化与去除index.php需同时满足Web服务器重写生效(如Apache启用mod_rewrite、AllowOverride All、正确.htaccess)和urlManager配置正确(enablePrettyUrl=true、showScriptName=false、使用yii\rest\UrlRule),缺一不可。

直接说结论:Yii框架的RESTful接口 URL 美化和去除 index.php 是同一套机制,核心依赖 urlManager 配置 + Web服务器重写规则,但 REST 场景下容易因路由匹配逻辑、Accept 头处理或 JSON 格式响应而暴露问题——不是配了就能用,得对齐请求路径与路由解析行为。
为什么 REST 接口启用 enablePrettyUrl 后仍带 index.php
根本原因不是配置漏了,而是 Apache/Nginx 没把请求真正转发给 index.php。即使 urlManager 设置了 'showScriptName' => false,若 Web 服务器没启用重写或 .htaccess 未生效,请求压根不会进 Yii 入口文件,自然无法触发美化逻辑。
- Apache 必须开启
mod_rewrite模块(取消httpd.conf中#LoadModule rewrite_module modules/mod_rewrite.so的注释) - 对应目录(通常是
web/)必须允许覆盖:AllowOverride All,不能是None -
.htaccess文件必须放在和index.php同级的目录(如frontend/web/),内容不能有语法错误(比如换行缺失、空格错位) - 常见错误现象:
404 Not Found(.htaccess 未生效)或500 Internal Server Error(RewriteRule 写错,比如漏空格、路径斜杠不一致)
urlManager 在 REST 场景下的关键配置项
RESTful 接口对路由规则更敏感,rules 不只是“好看”,它直接影响控制器动作是否被识别。默认的 path 格式不适用于 REST,必须显式启用 yii\rest\UrlRule。
-
'enablePrettyUrl' => true:必须为true,否则所有 URL 都走?r=xxx查询字符串模式 -
'showScriptName' => false:隐藏index.php,但前提是上一步 Web 服务器重写已就绪 -
'suffix' => '':REST 接口一般不加后缀(如.html),留空即可;若设为'.json',则所有请求必须带该后缀才能匹配 -
'rules'应包含['class' => 'yii\rest\UrlRule', 'controller' => ['user', 'post']],而不是手动写正则;否则GET /users、POST /users等标准方法会 404 - 避免混用:不要在同一个
urlManager里既写yii\rest\UrlRule又写普通字符串规则(如'login' => 'site/login'),优先级易冲突
Apache .htaccess 写法及常见陷阱
REST 请求常带 Content-Type: application/json 或无扩展名路径(如 /api/v1/users),.htaccess 必须保证这类路径也能被转发到 index.php,否则直接 404。
立即学习“PHP免费学习笔记(深入)”;
- 最简可用版本(放
web/目录下):
RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [L]
- 错误写法示例:
RewriteRule . index.php(缺[L]标志,可能引发循环重写) - 错误写法示例:
RewriteRule ^(.*)$ /index.php(开头多斜杠,路径变成绝对根路径,找不到index.php) - Nginx 用户注意:没有
.htaccess,需在 server 块中配置try_files $uri $uri/ /index.php?$args;,且确保fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;正确 - 测试是否生效:临时在
index.php开头加die('hit');,访问/users能输出说明重写成功;若直接 404,说明请求根本没到 PHP 层
REST 接口美化后仍 404 的真实原因
Web 服务器转发没问题,urlManager 配置也正确,但 GET /users 还是报 404?大概率是控制器命名、模块结构或路由注册顺序问题。
- 控制器类名必须是
UserController(而非UsersController),且继承yii\rest\ActiveController - 若接口在
api模块下,urlManager的controller数组要写成['api/user', 'api/post'],不能只写['user'] - 检查
bootstrap或modules配置是否加载了对应模块,未加载时api/user路由根本不存在 -
yii\rest\UrlRule默认只匹配index、view、create等标准动作;自定义动作(如actionSearch)需在extraPatterns中显式声明 - 开发环境建议打开
'enableStrictParsing' => true,能快速暴露路由不匹配问题,而不是静默 fallback 到首页
最常被忽略的是:重写规则生效 ≠ 路由匹配成功。前者是 Web 服务器的事,后者是 Yii 框架内部的 UrlRule 解析逻辑,两者必须同时成立,REST 接口的美化 URL 才真正可用。



















