ThinkPHP5 API 多版本控制开发

  • A+
所属分类:PHP ThinkPHP5

开发准备

对于接口开发,建议采用单独的项目部署,与后台项目分离开来,原因如下:

1. 接口多用于查询数据,对于数据提交的较少

2. 接口的权限多采用token模式,后台多采用RBAC控制访问

3. 对于需要高度安全的接口,需要进行加密处理。

首先建立新的项目,配置二级域名 api.xjwblog.com 。对于 APP 客户端开发,往往需要多版本的兼容,因此在服务端需要对接口进行兼容处理。

利用 ThinkPHP5 的多级控制器实现版本的控制

ThinkPHP5 多级控制器说明

以下我们以首页 banner 图为例:

在 route.php 中加入以下代码:

Route::get('/:version/banner', 'api/:version.Home/banner');

建立 api 模块,创建 controller 控制器层和 interfaces 接口约束层(对要实现的基本接口进行约束)以及 Home 文件, 结构如下:

ThinkPHP5 API 多版本控制开发

interfaces/Home.php 中代码如下:

<?php

namespace app\api\interfaces;

interface Home
{

    public function banner ();

}

controller/Base.php 中代码如下:

<?php

namespace app\api\controller;
use think\Controller;



class Base extends Controller
{

    public function _initialize ()
    {
        parent::_initialize ();
        
        //如有权限验证 加入权限验证
    }

}

controller/Home.php 中代码如下:

<?php

namespace app\api\controller;

class Home extends Base implements \app\api\interfaces\Home
{
    public function banner()
    {
        
    }

}

controller/v1/Home.php 中代码如下:

<?php

namespace app\api\controller\v1;

use app\api\controller\Home as BaseHome;

class Home extends BaseHome
{
    public function banner()
    {
        return json(['msg' => 'v1-banner']);
    }

}

controller/v2/Home.php 中代码如下:

<?php

namespace app\api\controller\v2;

use app\api\controller\Home as BaseHome;

class Home extends BaseHome
{
    public function banner()
    {
        return json(['msg' => 'v2-banner']);
    }

}

说明:

controller/Base.php 中存放一些公用的方法以及必要的验证

controller/Home.php 中存放一些公用的方法以及无需进行版本验证的接口

controller/v1/Home.php 中存放 v1 版本单独所需的接口以及覆盖父类 Home.php 中的接口进行个性化配置

controller/v2/Home.php 中存放 v2 版本单独所需的接口以及覆盖父类 Home.php 中的接口进行个性化配置

接下来利用 postman 进行测试:

ThinkPHP5 API 多版本控制开发

ThinkPHP5 API 多版本控制开发

avatar

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: