Laravel自定义封装Api接口

以你之姓@ 2022-11-29 05:56 338阅读 0赞

**1、创建统一接口文件ApiResponse.php **

![20200819171926674.png][] [Trait用法][Trait]

<?php
    
    namespace App\Helpers\Api;
    
    trait ApiResponse
    {
    
        /**
         * 成功的时候返回结果
         * @param $data 返回数据集合
        */
        public function success($data)
        {
            return $this->api_response('200','操作成功',$data);
        }
    
        /**
         * 失败的时候返回结果
        */
        public function fail($data)
        {
            return $this->api_response('500','操作失败',$data=[]);
        }
    
        /**
         * 直接返回说明
        */
        public function message($message)
        {
            return "$message";
        }
    
    
        /**
         * 参数返回
         * @param $code 状态码
         * @param $message 返回说明
         * @param $data 返回数据集合
        */
        public function api_response($code, $message, $data)
        {
            $content = [
                'code' => $code,
                'message'  => $message,
                'data' => $data
            ];
            return json_encode($content);
        }
    
    }

**2、在app\\Http\\Api下创建ApiController控制器  接口继承用**

![20200819172018318.png][]

<?php
    
    namespace App\Http\Controllers\Api;
    
    use App\Helpers\Api\ApiResponse;     //引用接口方法
    use App\Http\Controllers\Controller;
    
    
    class ApiController extends Controller
    {
    
    
        use ApiResponse;
    
        // 其他通用的Api帮助函数
    
    }

**3、开始写接口，测试用例StudentController.php 返回数据**

![2020081917204689.png][]

<?php
    
    
    namespace App\Http\Controllers\Api;
    
    
    use App\Models\Student;
    
    
    class StudentController extends ApiController
    {
        public function students()
        {
            $data = Student::all();
            return $this->success($data);
        }
    ｝

**4、写路由，在routes文件夹下的api.php**

![20200819172338392.png][]

<?php
    
    
    use Illuminate\Http\Request;
    use \Illuminate\Support\Facades\Route;
    
    
    Route::namespace('Api')->group(function () {
        Route::get('/students','StudentController@students')->name('student.students');
    });

**5、测试接口 访问：域名/api/students**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NzE4MTcw_size_16_color_FFFFFF_t_70][]

**6、返回提示信息**

![2020081917274074.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NzE4MTcw_size_16_color_FFFFFF_t_70 1][]

[20200819171926674.png]: /images/20221124/78808d9b782747128a181f4fe4dad2e3.png
[Trait]: https://xueyuanjun.com/post/4281.html
[20200819172018318.png]: /images/20221124/466f505e92eb47029ec4b4a3e5adad61.png
[2020081917204689.png]: /images/20221124/d36ccc108b3a47f0850722f0c9c4b318.png
[20200819172338392.png]: /images/20221124/8c7f7b11772140ec82e07142831fc75c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NzE4MTcw_size_16_color_FFFFFF_t_70]: /images/20221124/644c70527e124f13a855cc75634c5548.png
[2020081917274074.png]: /images/20221124/9740d4b6bc97464c8ad432da00c7b80d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NzE4MTcw_size_16_color_FFFFFF_t_70 1]: /images/20221124/c1d84da530d94e01a9d94bf86b3b2fb3.png