ThinkPHP8.0如何配置API版本

夜伟酱_1729

夜伟酱_1729

2026-07-22

1050人浏览

原创

thinkphp 8.0需手动组合路由分组与中间件实现双模式api版本控制:uri路径(如/api/v1/user)通过prefix分组路由,header(api-version)依赖中间件注入version参数并统一分发,uri优先级高于header。

thinkphp8.0如何配置api版本

要在ThinkPHP 8.0中让同一个API接口支持v1、v2等不同版本,并允许客户端通过URL路径(如/api/v1/user)或HTTP请求头(如Api-Version: v2)两种方式指定版本,必须手动组合路由分组与中间件逻辑——框架本身不提供开箱即用的双模式版本识别。

配置URI路径版本(原生稳定方式)

这一步直接利用TP8路由系统最底层的能力,无需额外解析,兼容性最好、性能最高。

打开route/app.php,在HTTP路由区块内,为每个版本单独定义一个带前缀的路由分组:

Route::group('api', function () { Route::get('user/:id', 'User/read')->name('api.v1.user.read'); })->prefix('api/v1/');

Route::group('api', function () { Route::get('user/:id', 'UserV2/read')->name('api.v2.user.read'); Route::post('user', 'UserV2/create'); })->prefix('api/v2/');

【prefix必须写在分组链式调用末尾,且不能和version()混用——后者在TP8中不参与路径匹配,仅作标记】

这样访问/api/v1/user/123会进入User@read,而/api/v2/user/123则命中UserV2@read,互不干扰。

启用Header版本支持(需中间件注入参数)

当客户端不想改URL,只想在请求头里加Api-Version: v2就切换逻辑时,必须靠中间件把头信息转成路由可识别的参数。

第一步:创建中间件文件app/middleware/ApiVersionMiddleware.php,内容如下:

namespace app\middleware;
use think\Request;
use think\Response;
class ApiVersionMiddleware
{
    public function handle(Request $request, \Closure $next): Response
    {
        $version = $request->header('Api-Version');
        if ($version && in_array($version, ['v1', 'v2'])) {
            $request = $request->withParam('version', $version);
        }
        return $next($request);
    }
}

第二步:将该中间件注册到全局中间件列表,在app/middleware.php中加入:
[\app\middleware\ApiVersionMiddleware::class],并确保它排在think\middleware\LoadLangPack::class之后、think\middleware\RouteCheck::class之前——顺序错了,$request->param('version')在路由匹配时就拿不到。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载

第三步:定义一个通用路由接收version参数,放在route/app.php中(注意要放在所有prefix分组之后):

Route::group('api', function () {
    Route::get('user/:id', function ($id) {
        $version = request()->param('version', 'v1');
        return $version === 'v2'
            ? \app\controller\UserV2::read($id)
            : \app\controller\User::read($id);
    });
})->prefix('api/');

此时访问/api/user/123并带上Api-Version: v2头,就会走v2逻辑;没带头则默认v1。URI优先级高于Header,所以/api/v2/user/123永远走v2,不管Header里写啥。

统一版本分发逻辑(避免重复判断)

方法一:在基础控制器中封装版本路由分发

新建app/controller/ApiBase.php,继承think\Controller,写一个dispatchByVersion方法:

protected function dispatchByVersion(string $action, array $params = []): mixed
{
    $version = $this->request->param('version', 'v1');
    $class = match($version) {
        'v1' => \app\controller\User::class,
        'v2' => \app\controller\UserV2::class,
        default => \app\controller\User::class,
    };
    return call_user_func_array([$class, $action], $params);
}

然后在具体控制器里调用:
return $this->dispatchByVersion('read', [$id]);

方法二:用服务容器绑定动态类

在app/provider/AppServiceProvider.php的register方法中加入:

$this->app->bind('api.user.service', function ($app) {
    $version = $app->request->param('version', 'v1');
    return match($version) {
        'v1' => new \app\service\UserV1Service(),
        'v2' => new \app\service\UserV2Service(),
    };
});

控制器中直接$this->app->make('api.user.service')->read($id)即可。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

thinkphp php php8

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

2026.10.15

0

20

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

2026.10.15

0

18

Vue.js 中 ref 和 reactive 的区别
Vue.js 中 ref 和 reactive 的区别

Vue.js中ref和reactive的区别专题汇集两种响应式API的定义、访问方式、对象解构、侦听与性能取舍等文章,帮助结合实际状态类型选择合适写法。

2026.10.15

0

20

VS Code 怎么配置开发环境
VS Code 怎么配置开发环境

VS Code开发环境专题汇集编辑器安装、语言扩展、编译器、解释器、终端和调试配置文章,覆盖Java、Python、C++和PHP等常见语言的入门设置。

2026.10.15

0

18

C++ 开发环境怎么搭建
C++ 开发环境怎么搭建

C++开发环境专题汇集Windows、Linux下的编译器与IDE安装配置教程,涵盖GCC、Clang、Visual Studio、CLion和VS Code,以及编译运行首个程序的步骤。

2026.10.15

0

19

Python 虚拟环境是什么
Python 虚拟环境是什么

Python虚拟环境专题介绍项目依赖隔离的作用,汇集venv与uv创建、激活、退出及解释器切换的相关文章,并覆盖Windows、Linux和VS Code中的常见配置问题。

2026.10.15

0

15

Python 怎么安装并配置环境变量
Python 怎么安装并配置环境变量

Python安装与环境变量配置专题汇集Windows、macOS和Linux的安装步骤、PATH设置、pip配置及常见报错排查文章,帮助完成解释器安装并验证命令行可以正常运行。

2026.10.15

0

15

PHP 连接 MySQL 失败怎么办
PHP 连接 MySQL 失败怎么办

PHP连接MySQL失败专题汇集PDO与MySQLi扩展配置、账号权限、主机端口、套接字和认证方式等排查文章,覆盖连接报错、密码变更与容器环境配置,帮助按错误提示定位原因并修复。

2026.10.15

0

18

PHP 表单提交后如何获取数据
PHP 表单提交后如何获取数据

PHP表单提交后如何获取数据专题汇集HTML表单提交、GET与POST接收、$_POST和$_GET读取、跨文件传值、单选与下拉字段获取,以及空值和接收失败排查等文章,帮助新手完成从提交到处理的完整流程。

2026.10.15

0

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程