ThinkPHP接口怎么写_ThinkPHPAPI接口开发规范【方法】-ThinkPHP-PHP中文网

thinkphp接口开发需闭环执行路由绑定、控制器分层、参数校验和响应封装四步；跳过任一环将导致404、空数据、500或前端解析失败。

thinkphp接口怎么写_thinkphpapi接口开发规范【方法】

ThinkPHP 接口不是“写一个函数就完事”，核心在于路由绑定、控制器分层、参数校验和响应封装这四步是否闭环。跳过任意一环，上线后大概率会遇到 404、空数据、500 或前端解析失败。

路由怎么配才不会 404

ThinkPHP 的路由必须显式声明，不配就找不到控制器；且 api.php 路由文件只对 Route::get/Route::post 等方法生效，不能直接写 Route::rule 混用（除非你主动 require）。

推荐把所有 API 路由集中写在 route/api.php，并确保该文件被 route/app.php 或入口自动加载
RESTful 风格建议用 Route::resource，比如 Route::resource('users', 'api/Users')，它会自动生成 index/create/store 等 7 个标准动作，不用手动写一堆 Route::get('users/list', ...)
如果用 Route::post('api/login', 'api/Login/login')，注意路径前缀 api/ 是纯字符串，不带自动版本控制——要加 v1 就得写成 api/v1/login
调试时用 php think route:list 查看实际注册的路由，避免拼错控制器名或方法名（大小写敏感）

控制器里怎么取参数才安全

$request->param() 是最常用方式，但它默认合并 GET+POST+PUT/PATCH 的 body 数据，而 JSON 请求体不会自动解析进 $_POST，所以直接 $request->param() 可能拿不到字段。

btpanel phpsite 宝塔面板PHP网站

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

下载

JSON 请求必须先调用 $request->isJson() 判断，再用 $request->post() 或 $request->body() + json_decode 手动解析
不要用 input('param_name') 这类全局助手函数，它绕过 Request 对象，丢失类型推断和过滤能力
必填参数必须验证：用 validate 类或 $request->validate() 方法，比如 $request->validate(['username' => 'require|alphaNum|max:20'])，失败直接返回 400，不用手写 if 判断
数据库字段名别直接透传给前端，Db::table('user')->field('id,name,email')->select() 比 select(*) 更可控

为什么 json() 返回的数据前端总解析错

ThinkPHP 的 json() 助手函数默认设了 Content-Type: application/json，但如果你在控制器里先 echo 了别的内容（比如调试用的 var_dump），或者 header 已被输出，就会导致 JSON 前混入空白或 HTML，前端 JSON.parse 报错。

永远用 return json(...)，不要 echo json_encode(...) —— 后者不走框架响应生命周期，中间件、事件、日志都失效
统一响应结构必须封装成方法或基类，比如在 app/base/Controller.php 里定义 success($data = null, $msg = 'success')，避免每个接口重复写 ['code' => 200, 'msg' => ..., 'data' => ...]
异常不能靠裸 throw，要用 try/catch 包住 DB 操作，并 return json(['code' => 500, 'msg' => '数据库查询失败'])，否则框架可能返回 HTML 错误页
中文乱码？确认 PHP 文件本身是 UTF-8 无 BOM 格式，且数据库连接设置了 charset=utf8mb4

Token 验证放哪最合适

放在每个控制器方法开头手写 checkToken() 是反模式。ThinkPHP 的中间件才是标准解法，尤其适合鉴权、日志、CORS 等横切关注点。

运行 php think make:middleware CheckToken 创建中间件，在 handle() 里解析 Header 中的 Authorization: Bearer xxx，验证失败直接 return json(['code' => 401, 'msg' => '未授权'])
在 app/middleware.php 中配置全局或分组中间件，比如给全部 api/* 路由加 CheckToken::class
别在中间件里用 session_start() 或依赖 Cookie——API 应该是无状态的，Token 就是唯一凭证
JWT 解析建议用 firebase/php-jwt，自己 base64_decode + json_decode 容易漏签名校验