ThinkPHP6 API接口开发项目实战

ThinkPHP6API接口开发1.环境准备与项目创建bashcomposercreate-projecttopthink/thinktp6-apicdtp6-api安装完成后，配置.env文件中的数据库连接信息。2.目录结构与命名约定推荐使用以下目录结构组织API相关代码：textapp/├──api///API模块目录│├──controller///控制器│├──model///模型│├──validate///验证器│└──route///独立路由文件（可选）├──BaseController.php//基础控制器└──...在config/app.php中开启多应用模式（默认已开启）：php'auto_multi_app'=>true,3.路由配置在route/app.php（或route/api.php）中定义API路由：phpusethink\facade\Route;//分组+版本控制Route::group('v1',function(){//资源路由（自动生成7个常用接口）Route::resource('users','User');//自定义路由Route::post('login','Auth/login');Route::get('profile','User/profile')->middleware('auth');})->prefix('api/v1.');//指向app\api\v1\controller如果希望路由文件分离，在config/route.php中设置：php'route_file'=>['api'=>'api/route/api.php',],4.控制器编写创建app\api\v1\controller\User.php：php<?phpnamespaceapp\api\v1\controller;useapp\BaseController;usethink\exception\ValidateException;useapp\api\v1\model\UserasUserModel;classUserextendsBaseController{protected$middleware=['auth'];//控制器中间件//列表GET/v1/userspublicfunctionindex(){$list=UserModel::paginate(15);returnjson(['code'=>200,'msg'=>'success','data'=>$list]);}//单个详情GET/v1/users/:idpublicfunctionread($id){$user=UserModel::find($id);if(!$user){returnjson(['code'=>404,'msg'=>'用户不存在'],404);}returnjson($user);}//创建POST/v1/userspublicfunctionsave(){$data=$this->request->post();//使用验证器try{validate(\app\api\v1\validate\User::class)->check($data);}catch(ValidateException$e){returnjson(['code'=>422,'msg'=>$e->getError()],422);}$user=UserModel::create($data);returnjson(['code'=>201,'data'=>$user],201);}//更新PUT/v1/users/:idpublicfunctionupdate($id){$data=$this->request->put();$user=UserModel::find($id);if(!$user){returnjson(['code'=>404,'msg'=>'用户不存在'],404);}$user->save($data);returnjson(['code'=>200,'msg'=>'更新成功']);}//删除DELETE/v1/users/:idpublicfunctiondelete($id){$user=UserModel::find($id);if($user){$user->delete();}returnjson(['code'=>204,'msg'=>'删除成功'],204);}}5.模型层模型继承\think\Model，建议使用软删除、自动时间戳等特性。php<?phpnamespaceapp\api\v1\model;usethink\Model;classUserextendsModel{protected$table='users';protected$autoWriteTimestamp=true;protected$hidden=['password'];//隐藏敏感字段//修改器：密码加密publicfunctionsetPasswordAttr($value){returnpassword_hash($value,PASSWORD_DEFAULT);}}6.验证器验证器放在app\api\v1\validate\User.php：php<?phpnamespaceapp\api\v1\validate;usethink\Validate;classUserextendsValidate{protected$rule=['username'=>'require|max:20|unique:users','email'=>'require|email|unique:users','password'=>'require|length:6,20',];protected$message=['username.require'=>'用户名必须','email.require'=>'邮箱必须',];//场景控制（可选）protected$scene=['login'=>['username','password'],];}7.请求与响应规范统一响应格式创建一个ApiResponsetrait或基类方法：phptraitApiResponse{protectedfunctionsuccess($data=[],$msg='success',$code=200){returnjson(['code'=>$code,'msg'=>$msg,'data'=>$data,'time'=>time()]);}protectedfunctionerror($msg='error',$code=400,$data=[]){returnjson(['code'=>$code,'msg'=>$msg,'data'=>$data,],$code);}}在控制器中使用useApiResponse;即可调用。全局异常处理修改app\ExceptionHandle.php的render方法，使API模式返回JSON：phppublicfunctionrender($request,Throwable$e){if($request->isAjax()||$request->isJson()){returnjson(['code'=>$e->getCode()?:500,'msg'=>$e->getMessage()],500);}returnparent::render($request,$e);}8.中间件JWT身份验证中间件安装firebase/php-jwt：bashcomposerrequirefirebase/php-jwt创建中间件app\http\middleware\Auth.php：php<?phpnamespaceapp\http\middleware;useFirebase\JWT\JWT;useFirebase\JWT\Key;classAuth{publicfunctionhandle($request,\Closure$next){$token=$request->header('Authorization');$token=str_replace('Bearer','',$token);try{$decoded=JWT::decode($token,newKey(config('app.jwt_key'),'HS256'));$request->user=$decoded->data;//注入用户信息}catch(\Exception$e){returnjson(['code'=>401,'msg'=>'未授权或令牌失效'],401);}return$next($request);}}注册中间件config/middleware.php：phpreturn['alias'=>['auth'=>\app\http\middleware\Auth::class,],];CORS跨域中间件php//中间件app\http\middleware\Cors.phppublicfunctionhandle($request,\Closure$next){header('Access-Control-Allow-Origin:*');header('Access-Control-Allow-Methods:GET,POST,PUT,DELETE,OPTIONS');header('Access-Control-Allow-Headers:Content-Type,Authorization');if($request->method()==='OPTIONS'){exit;}return$next($request);}9.数据转换（资源类）ThinkPHP6没有内置的资源类，但可以手动实现或使用第三方扩展。推荐使用league/fractal或自己编写简单的转换层。示例：创建app\api\v1\resource\UserResource.phpphpclassUserResource{publicstaticfunctiontoArray($user){return['id'=>$user->id,'name'=>$user->username,'email'=>$user->email,'avatar'=>$user->avatar?url($user->avatar):null,'created_at'=>$user->create_time,];}}在控制器中使用：phpreturn$this->success(UserResource::toArray($user));10.接口文档生成推荐使用注解方式生成OpenAPI（Swagger）文档。安装zircote/swagger-php：bashcomposerrequirezircote/swagger-php在控制器方法上写注解：php/***@OA\Get(*path="/v1/users",*summary="获取用户列表",*@OA\Response(response=200,description="成功")*)*/publicfunctionindex(){...}然后执行vendor/bin/openapi--outputpublic/swagger.jsonapp/api生成文档。11.性能优化建议开启路由缓存：phpthinkoptimize:route配置数据库连接池（如使用Swoole）使用Redis缓存频繁查询的数据对返回数据使用json_encode选项：json($data,200,['Content-Type'=>'application/json'],JSON_UNESCAPED_UNICODE)12.示例：完整用户登录流程php//AuthController.phppublicfunctionlogin(Request$request){$data=$reques