iambib / api-version-fallback
一个允许您拥有API回退版本的软件包
v1.0.3
2023-03-13 17:39 UTC
Requires
- php: >= 8.0.2
- laravel/lumen-framework: ^9.0 || ^10.0
This package is auto-updated.
Last update: 2024-09-13 20:47:30 UTC
README
Lumen Api版本控制
一个允许您为Lumen api提供回退版本的软件包
描述
此软件包允许您为API提供回退版本。基本上,如果您已经部署了v1,并希望将应用程序更新到v2,但没有时间更新所有方法,此软件包允许您暂停更新。例如:#1 api.dev/v2/users 如果找不到v2,将回退到 api.dev/v1/users。例如:#2 api.dev/v3/users 如果找到,将回退到 api.dev/v2/users,如果没有,将回退到 api.dev/v1/users
安装
composer require iambib/lumen-api-versioning
配置文件
创建一个名为 api-versioning.php 的配置文件,并添加以下行
return [ /** * Enable the fallback */ 'enable' => true, /** * Available api versions */ 'available_versions' => [ 'v1', 'v2', ], /** * Set them in order you want the fallback to happen * Eg. If v4 is not found v3 is the first one to check if exists. If not, v2 then v1. */ 'api_fallbacks' => [ 'v3', 'v2', 'v1', ], /* * URL segment number of your api version */ 'segment_no' => 0, ];
bootstrap/app.php
$app = new \iAmBiB\ApiVersionFallback\Extension\Application( $_ENV['APP_BASE_PATH'] ?? dirname(__DIR__) ); ... $app->middleware([ ... 'api_versioning_fallback' => \iAmBiB\ApiVersionFallback\Middleware\ApiVersioningFallback::class, ]); ... $app->configure('api-versioning');