接口版本号

框架默认占用v1版本号，当您对调用的接口需要进行二次开发时，我们建议不要直接修改公共模块内的成员函数，
而是另起一个版本号，将框架与二次开发所修改的内容区分开。

下面将举例说明如何进行新增、修改、删除。

管理控制器类

  1. 在app/api/controller目录下新建v2目录，也可以自主设计目录名称，例如叫“ver2.0”，但名称在 URL 访问与命名空间时必须一致（演示讲解时一律使用v2名称）。

  2. 之后在v2目录下创建控制器类文件，如果是在某个控制器类的基础上进行二次开发，那么二者的文件名称必须一致，并且继承于对应的v1控制器类。 如果是一个完全独立、新增的控制器类，那么必须继承于\app\api\controller\CareyShop。

演示代码片段

完成上面的操作后就可以实际写入代码，演示代码以v1版本下的Index控制器为例，对各种会运用到的状况都做了解释。

  1. <?php
  2. /**
  3.  * @copyright   Copyright (c) http://careyshop.cn All rights reserved.
  4.  *
  5.  * CareyShop    自定义接口版本号v2演示
  6.  *
  7.  * @author      zxm <252404501@qq.com>
  8.  * @date        2020/10/10
  9.  */
  11. namespace app\api\controller\v2;
  13. use app\careyshop\service\Index as IndexService;
  15. class Index extends \app\api\controller\v1\Index
  16. {
  17.     /**
  18.      * 方法1:通过方法路由器
  19.      * 重写该成员函数,通过"self::$route"键名对应的值来改变请求方法的重定位
  20.      * 如果需要继承父类"self::$route"的初始值,则需要执行"parent::initMethod()"
  21.      * 不执行状态下,v1与v2属于完全独立的请求接口
  22.      *
  23.      * 如果选择不继承初始值,那么建议当前类从"\app\api\controller\CareyShop.php"继承
  24.      * 而不是从"\app\api\controller\v1\Index"继承
  25.      *
  26.      * @access protected
  27.      * @return void
  28.      */
  29.     protected static function initMethod()
  30.     {
  31.         /**
  32.          * 父类"self::$route"的初始值
  33.          * self::$route = [
  34.          * // API访问测试
  35.          * 'get.index.host'      => ['getIndexHost', false],
  36.          * // 清空所有缓存
  37.          * 'clear.cache.all'     => ['clearCacheAll', IndexService::class],
  38.          * // 调整最优状态(正式环境有效)
  39.          * 'set.system.optimize' => ['setSystemOptimize', IndexService::class],
  40.          * // 获取系统版本号
  41.          * 'get.system.version'  => ['getVersion', IndexService::class],
  42.          * ];
  43.          */
  44.         parent::initMethod();
  46.         // 父方法路由器键名不存在"get.system.v2"方法,表示新增一个接口
  47.         self::$route['get.system.v2'] = ['getMethodV2', false];
  49.         // 父方法路由器键名存在"get.system.version"方法,表示修改一个接口
  50.         self::$route['get.system.version'] = ['getVersion', false];
  52.         // 删除从父方法路由器继承过来的"set.system.optimize"方法
  53.         unset(self::$route['set.system.optimize']);
  55.         /**
  56.          * 假设不执行"parent::initMethod()",那么"Index"控制器最终请求方法结果如下:
  57.          * "get.index.host"与"clear.cache.all" v1、v2都不可请求
  58.          * "set.system.optimize" v1可请求,v2不可请求
  59.          * "get.system.version" v1、v2都可请求,但返回内容不同
  60.          * "get.system.v2" v1不可请求,v2可请求
  61.          * 至于方法路由器中的键值含义请参考 https://doc.careyshop.cn/guide/controller/
  62.          */
  64.         /**
  65.          * 假设执行过"parent::initMethod()",那么"Index"控制器最终请求方法结果如下:
  66.          * "get.index.host"与"clear.cache.all" v1、v2都可请求,且结果相同
  67.          * "set.system.optimize" v1可请求,v2不可请求
  68.          * "get.system.version" v1、v2都可请求,但返回内容不同
  69.          * "get.system.v2" v1不可请求,v2可请求
  70.          * 至于方法路由器中的键值含义请参考 https://doc.careyshop.cn/guide/controller/
  71.          */
  72.     }
  74.     /**
  75.      * 方法2:通过自定义初始化
  76.      * 重写该成员函数,与方法1的区别是重写该成员函数不需要执行"parent::initMethod()"
  77.      * 默认状态下就已经继承父类"self::$route"的初始值
  78.      *
  79.      * @access protected
  80.      * @return void
  81.      */
  82.     protected static function init()
  83.     {
  84.         // 父方法路由器键名不存在"get.system.v2"方法,表示新增一个接口
  85.         // self::$route['get.system.v2'] = ['getMethodV2', false];
  87.         // 父方法路由器键名存在"get.system.version"方法,表示修改一个接口
  88.         // self::$route['get.system.version'] = ['getVersion', false];
  90.         // 删除从父方法路由器继承过来的"set.system.optimize"方法
  91.         // unset(self::$route['set.system.optimize']);
  93.         /**
  94.          * 假设上方注释的代码段完成执行,那么"Index"控制器最终请求方法结果如下:
  95.          * "get.index.host"与"clear.cache.all" v1、v2都可请求,且结果相同
  96.          * "set.system.optimize" v1可请求,v2不可请求
  97.          * "get.system.version" v1、v2都可请求,但返回内容不同
  98.          * "get.system.v2" v1不可请求,v2可请求
  99.          * 至于方法路由器中的键值含义请参考 https://doc.careyshop.cn/guide/controller/
  100.          */
  101.     }
  103.     /**
  104.      * 假设请求条件同为 "method": "get.system.v2"时,
  105.      * 访问 http://{{host}}/v1/index 会提示错误,原因是v1版本下不存在此接口
  106.      * 访问 http://{{host}}/v2/index 会正确返回执行结果
  107.      *
  108.      * @access public
  109.      * @return string
  110.      */
  111.     public function getMethodV2()
  112.     {
  113.         return '基于CareyShop商城框架系统,新增v2接口数据返回';
  114.     }
  116.     /**
  117.      * 假设请求条件同为 "method": "get.system.version"时,
  118.      * 访问 http://{{host}}/v1/index 返回:
  119.      * {"status":200,"message":"success","data":{"version":"1.3.0"}}
  120.      * 访问 http://{{host}}/v2/index 返回:
  121.      * {"status":200,"message":"success","data":{"version":"1.3.0","v2":"基于CareyShop商城框架系统,修改为v2接口后数据返回"}}
  122.      *
  123.      * @access public
  124.      * @return array
  125.      */
  126.     public function getVersion()
  127.     {
  128.         $indexService = new IndexService();
  129.         $data = $indexService->getVersion();
  130.         $data['v2'] = '基于CareyShop商城框架系统,修改为v2接口后数据返回';
  132.         return $data;
  133.     }
  134. }

备注： 在示例中方法路由器的具体使用可以查阅，接口控制器。