jdlxnl / api-version

将版本号添加到路由的前缀中,并通过Laravel的门面使其可用

1.0.0 2021-12-23 10:23 UTC

This package is auto-updated.

Last update: 2024-09-23 16:57:12 UTC


README

允许您创建API版本前缀,并将其在代码中可用。

安装后您可以

use Jdlx\ApiVersion\Facade\Version;

// get current version number as int
Version::number();

// Do something only for request to the old api
if(Version::before(2)){

}

// Do something only for request to the new api
if(Version::from(2)){

}

安装

composer require jdlxnl/api-version

注册门面

 // app/Http/kernel.php
 // Add api midleware

   protected $middlewareGroups = [
        'api' => [
            SetApiVersion::class,
          ],
    ];

// app/Config/app.php

  'providers' => [
        ...
        App\Library\ApiVersion\Provider\ApiVersionServiceProvider::class
    ]

 // change base path for swagger
 // app/Http/Documentation/Server


// Add the option to the router
// routes/api.php
$apiRoutes = function () {
    // define routes
};
Route::group(['prefix' => '{version?}', 'where' => ['version' => 'v[0-9]+']], $apiRoutes);