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

夜敏吖_6850

夜敏吖_6850

2026-07-11

719人浏览

原创

thinkphp 6.0 开发 restful api 需手动完成控制器创建、资源路由注册、json 显式返回及请求方法重写;控制器需用 php think make:controller api/user 生成并继承 think\controller,路由须在 app/route/app.php 中写 route::resource('user', 'api.user'),方法名严格为 index/read/save/update/delete,所有返回必须用 json() 函数,前端 put/delete 请求需加 x-http-method-override 头。

thinkphp 6.0 开发 restful api 全流程【新手】

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

这条语句会映射:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • GET /user → api\UserController::index()
  • POST /user → api\UserController::save()
  • GET /user/1 → api\UserController::read($id)
  • PUT /user/1 → api\UserController::update($id)
  • DELETE /user/1 → api\UserController::delete($id)

方法名必须严格为 index、read、save、update、delete——写成 show、list、store 都不会被识别。

每个方法都要手动返回 JSON,不能只写 return 数组

TP6 默认响应类型是 HTML,即使你访问的是 API 路由,写 return ['data' => $user]; 也会导致空白页、500 错误,甚至输出未格式化的数组文本。

必须显式调用 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"

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

thinkphp restful api php

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

相关专题

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

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

2023.09.01

10924

6

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

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

2023.10.11

6361

5

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

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

2023.10.11

2135

5

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

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

2023.10.23

4028

4

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

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

2023.10.23

4734

6

html怎么上传
html怎么上传

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

2023.11.03

3711

9

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

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

2023.11.09

5317

8

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

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

2023.11.13

4162

8

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

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

2023.11.27

12062

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程