整理总结thinkphp5如何使用restful

布满荆棘的人生 2023-01-01 11:53 235阅读 0赞

### 整理总结thinkphp5如何使用restful ###

*   *  创建api目录
     *  在api目录中创建控制器和配置文件
     *  api的test控制器
     *  config.php中配置返回格式
     *  设置路由
     *   *  自动注册路由规则
         *  单独设置路由
     *  get方式请求
     *  put方式请求
     *  delete方式请求
     *  post方式请求
     *  通用化API接口数据封装

## 创建api目录 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70]

## 在api目录中创建控制器和配置文件 ##

如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 1]

## api的test控制器 ##

![在这里插入图片描述][20210102171109711.png]

<?php
    
    namespace app\api\controller;
    
    use think\Controller;
    
    class Test extends Controller
    { 
    
        public function index()
        { 
            return [
                'status' => 0,
                'msg' => 'success'
            ];
        }
    
        //put 需要定义$id
        public function update($id = '')
        { 
            $put_data = input('put.');
            $data = array(
                'id' => $id,
                'put_data' => $put_data
            );
            return $data;
        }
    
        //delete 需要定义$id 然后用提交的id值替换
        public function delete($id = '')
        { 
    
            $data = array(
                'id' => $id,
            );
            return $data;
        }
    
        //post 需要定义$id
        public function save()
        { 
            $post_data = input('post.');
            $data = array(
                'post_data' => $post_data
            );
            return $data;
        }
    }

## config.php中配置返回格式 ##

<?php
    
    return [
        //设置返回数据类型为json格式
        'default_return_type'=>'json',
    
    ];

## 设置路由 ##

在thinkphpwu/application目录下有一个route.php文件

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 2]

### 自动注册路由规则 ###

在路由配置文件中使用\_\_rest\_\_添加资源路由定义：

return [
        // 定义资源路由
        '__rest__'=>[
            // 指向index模块的blog控制器
            'blog'=>'index/blog',
        ],
        // 定义普通路由
        'hello/:id'=>'index/hello',
    ]

设置后会自动注册7个路由规则

<table> 
 <thead> 
  <tr> 
   <th>标识</th> 
   <th>请求类型</th> 
   <th>生成路由规则</th> 
   <th>对应操作方法（默认）</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>index</td> 
   <td>GET</td> 
   <td>blog</td> 
   <td>index</td> 
  </tr> 
  <tr> 
   <td>create</td> 
   <td>GET</td> 
   <td>blog/create</td> 
   <td>create</td> 
  </tr> 
  <tr> 
   <td>save</td> 
   <td>POST</td> 
   <td>blog</td> 
   <td>save</td> 
  </tr> 
  <tr> 
   <td>read</td> 
   <td>GET</td> 
   <td>blog/:id</td> 
   <td>read</td> 
  </tr> 
  <tr> 
   <td>edit</td> 
   <td>GET</td> 
   <td>blog/:id/edit</td> 
   <td>edit</td> 
  </tr> 
  <tr> 
   <td>update</td> 
   <td>PUT</td> 
   <td>blog/:id</td> 
   <td>update</td> 
  </tr> 
  <tr> 
   <td>delete</td> 
   <td>DELETE</td> 
   <td>blog/:id</td> 
   <td>delete</td> 
  </tr> 
 </tbody> 
</table>

具体指向的控制器由路由地址决定，例如上面的设置，会对应index模块的blog控制器，你只需要为Blog控制器创建以上对应的操作方法就可以支持下面的URL访问：

> http://serverName/blog/  
> http://serverName/blog/128  
> http://serverName/blog/28/edit

Blog控制器中的对应方法如下：

namespace app\index\controller;
    class Blog { 
        public function index(){ 
        }
        
        public function read($id){ 
        }    
        
        public function edit($id){ 
        }    
    }

### 单独设置路由 ###

具体代码如下：

<?php
    //引用think的路由底层Route类
    use think\Route;
    
    //设置路由
    
    //get方式
    Route::get('test', 'api/test/index');
    
    //put方式
    Route::put('test/:id', 'api/test/update');
    
    //delete方式
    Route::delete('test/:id', 'api/test/delete');
    
    //post方式
    //Route::post('test', 'api/test/save');
    
    //resource方式 对应7种方式
    Route::resource('test', 'api/test');

> Route::resource(‘test’, ‘api/test’); 这种方式包含了post方式请求，自动查找对应的save方法

## get方式请求 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 3]  
返回后台设置的内容

## put方式请求 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 4]  
请求路径为http://app.thinkphpwu.com/test/888  
对应的888表示id，put\_data就是我们提交的数据，后台可以根据自身的业务进行修改操作

## delete方式请求 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 5]  
请求的是delete方法，返回要删除的id的值

## post方式请求 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 6]

## 通用化API接口数据封装 ##

在application目录中的公共函数common.php 文件 增加 show方法

/** * 通用化API接口数据输出 * @param int $status 业务状态码 * @param string $message 信息提示 * @param [] $data 数据 * @param int $httpCode http状态码 * @return array */
    function show($status, $message, $data = [], $httpCode = 200)
    { 
    
        $data = [
            'status' => $status,
            'message' => $message,
            'data' => $data,
        ];
    
        return json($data, $httpCode);
    }

在需要返回给前端的函数中调用show方法，比如我们在test控制器的save方法中调用show，代码如下：

public function save()
        { 
            $post_data = input('post.');
            $data = array(
                'post_data' => $post_data
            );
            return show(0, '保存成功！', $data);
        }

使用postman请求，得到返回的数据如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 7]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70]: /images/20221120/fbf64d4472a34d10b5b1865059e23a31.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 1]: /images/20221120/278d0ff6ad334f21b89636198cfb6d9f.png
[20210102171109711.png]: /images/20221120/d66b88e26a0248ec98bb29ff722928b3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 2]: /images/20221120/3992091ed96e4a4ea3014b4a0a6ac337.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 3]: /images/20221120/6752797104f945f3a4d6d83ceca15355.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 4]: /images/20221120/797d204a6c9f48fabe38d416f0faf39a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 5]: /images/20221120/d6c0b7117d1c4c3bb1ea3d931dad4bc7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 6]: /images/20221120/238a901fce3546c2b1575c1653c9e2ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1b19xaWFuZ3FpYW5n_size_16_color_FFFFFF_t_70 7]: /images/20221120/9af82ee39c5b46d5a3bf6497e0604f89.png