商城首页欢迎来到中国正版软件门户

您的位置: 首页 > 文章列表 > 编程开发 > ThinkPHP 6.0 开发 RESTful API 全流程【新手】

ThinkPHP 6.0 开发 RESTful API 全流程【新手】

  发布于2026-07-11 阅读(0)

扫一扫,手机访问

先说几个判断:ThinkPHP 6.0 要开发一套完整的 RESTful API,官方并没有提供“一键生成”的傻瓜式命令。很多关键步骤——比如控制器创建、路由注册、JSON 返回格式、请求方法重写——都得手动补齐,少一步就可能导致路由不通、方法不触发、返回空白甚至报错。下面把从零到可运行的完整流程拆开来讲,尽量让新手也能跟上节奏。

ThinkPHP 6.0 开发 RESTful API 全流程【新手】

创建控制器要按路径命名,不能加 --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 /userapi\UserController::index()
  • POST /userapi\UserController::sa ve()
  • GET /user/1api\UserController::read($id)
  • PUT /user/1api\UserController::update($id)
  • DELETE /user/1api\UserController::delete($id)

方法名必须严格为 indexreadsa veupdatedelete——写成 showliststore 都不会被识别。

每个方法都要手动返回 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: PUT
  • X-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 就能跑起来了。如果你在哪个环节卡住,不妨回头对照一下,大概率是某个细节没对齐。

本文转载于:https://www.php.cn/faq/2808616.html 如有侵犯,请联系zhengruancom@outlook.com删除。
免责声明:正软商城发布此文仅为传递信息,不代表正软商城认同其观点或证实其描述。

热门关注