ThinkPHP 6.0 开发 RESTful API 全流程【新手】
ThinkPHP6.0开发RESTfulAPI需手动完成四个步骤:控制器按命名空间创建,资源路由在app.php显式注册,方法名严格对应且手动返回json(),前端PUT/DELETE请求需加X-HTTP-Method-Override头,以上步骤缺一不可。
先说几个判断:ThinkPHP 6.0 要开发一套完整的 RESTful API,官方并没有提供“一键生成”的傻瓜式命令。很多关键步骤——比如控制器创建、路由注册、JSON 返回格式、请求方法重写——都得手动补齐,少一步就可能导致路由不通、方法不触发、返回空白甚至报错。下面把从零到可运行的完整流程拆开来讲,尽量让新手也能跟上节奏。

创建控制器要按路径命名,不能加 --api 参数
TP6 的 php think make:controller 命令,根本不支持 --api 或 --resource 参数。如果你尝试运行 php think make:controller User --api,会直接报错:Unknown option --api——这不是你配置错了,而是框架压根没实现这个功能。
正确的做法是用命名空间路径来生成:
php think make:controller api/User
这条命令会在 app/controller/api/User.php 创建文件,类名默认是 UserController。你需要手动确认它继承自 think\Controller(不是 think\facade\Controller),并确保不加载视图(TP6 默认可能尝试渲染模板):
- 在控制器顶部写
use think\Controller; - 类定义为
class UserController extends Controller - 不需要手动设
$this->view = null,因为think\Controller已经禁用了视图功能
资源路由必须显式注册,且位置和写法有硬要求
生成控制器之后,不会自动绑定任何路由。必须去 app/route/app.php(注意不是 api.php,也不是中间件分组里)添加:
Route::resource('user', 'api.User');
这里有两个细节需要注意:
- 第二个参数写
'api.User'(点号分隔),不是'api/User'或'api\UserController' - 如果启用了多应用模式,要先确认
api是已在app/multi.php中启用的应用名,否则解析失败直接返回 404
这条语句会映射出以下路由:
GET /user→api\UserController::index()POST /user→api\UserController::sa ve()GET /user/1→api\UserController::read($id)PUT /user/1→api\UserController::update($id)DELETE /user/1→api\UserController::delete($id)
方法名必须严格为 index、read、sa ve、update、delete——写成 show、list、store 都不会被识别。
每个方法都要手动返回 JSON,不能只写 return 数组
TP6 默认的响应类型是 HTML,即使你访问的是 API 路由,如果直接写 return ['data' => $user];,结果可能是空白页、500 错误,或者输出未格式化的数组文本,完全不是你要的 JSON。
必须显式调用 json() 辅助函数:
return json(['code' => 0, 'data' => $users]);(列表)return json(['code' => 0, 'data' => $user], 201);(新建成功,建议返回 201)return json(['code' => 1, 'msg' => '用户不存在'], 404);(错误状态码也建议带上)
不要用 echo json_encode() + exit,那样会破坏框架的生命周期;也不要用 Response::create(..., 'json'),json() 更简洁,也更推荐。
前端发 PUT/DELETE 请求失败?加请求头就行
浏览器表单、部分 SDK(比如 Axios 的默认配置)只支持 GET/POST,发不出原生 PUT/DELETE,服务端收到后会直接返回 405 Method Not Allowed。
解决方案很简单:前端在 POST 请求中加一个自定义 header:
X-HTTP-Method-Override: PUTX-HTTP-Method-Override: DELETE
TP6 的路由层原生识别这个 header,并自动重写请求方法,后端代码完全不用改。测试时用 curl 最可靠:
curl -X POST -H "X-HTTP-Method-Override: PUT" http://localhost/user/1 -d "name=test"
以上四个步骤,每一步都是硬性要求,缺一不可。只要按顺序走下来,一套标准的 RESTful API 就能跑起来了。如果你在哪个环节卡住,不妨回头对照一下,大概率是某个细节没对齐。


































