详解Laravel5.6通过路由进行API版本控制的简单方法

时间:2022-07-27
本文章向大家介绍详解Laravel5.6通过路由进行API版本控制的简单方法,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

Laravel版本:5.6

API随着迭代,新版本往往需要继承老版本的功能,并对原有的功能修改和扩展,这时为了兼容各个版本的接口,就需要进行版本控制。

请求版本区分:

在请求的header中附带版本信息,如app-version:1.0.1

laravel这边的获取方法:

Request::header('app-version');

文件路径:

1.0.1版本的UserController,文件路径就是 app/Http/Controllers/Api/v1d0d1/UserController.php

1.0.2版本,就是 app/Http/Controllers/Api/v1d0d2/UserController.php

注意1.0.2版本如果需要使用1.0.1原有的功能,需要继承原有的类

use AppHttpControllersApiUserController as UserCtrl;
class UserController extends UserCtrl
{
  ...
}

版本控制

版本解析方法:

function getRouteContoller($controllerName)
{
  $base_path = 'AppHttpControllersApi';
  //无版本
  $app_version = Request::header('app-version');
  if (!$app_version) return $controllerName;
  //当前版本
  $version_path = 'v' . str_replace('.', 'd', $app_version) . '';
  $controllerPath = $base_path . $version_path . $controllerName;
  if (class_exists($controllerPath)) {
    return $version_path . $controllerName;
  }
  //往期版本
  $versionNumbers = intval(str_replace('.', '', $app_version));
  for ($i = $versionNumbers - 1; $i   0; $i--) {
    $version_path = 'v' . implode('d', str_split($i)) . '';
    $controllerPath = $base_path . $version_path . $controllerName;
    if (class_exists($controllerPath)) {
      return $version_path . $controllerName;
    }
  }
  return $controllerName;
}

注:该方法会将1.0.2版本解析为v1d0d2,并判断对应类是否存在,如果存在则直接返回类的路径;不存在则向下寻找1.0.1版本类是否存在,直到找到存在的类返回。

路由文件

Route::post('login', getRouteContoller('UserController').'login');

以上就是本文的全部内容,希望对大家的学习有所帮助。