mbpcoder/laravel-api-versioning

为Laravel启用API版本控制

v1.3 2023-04-03 14:24 UTC

This package is auto-updated.

Last update: 2024-09-03 17:40:06 UTC


README

Latest Version on Packagist Total Downloads

这是一个非常简单的包,用于支持Laravel 8、7、6、5中的API版本控制。此包为Laravel提供回退API功能。

特性

  • 如果你有一个API版本,它将自动禁用
  • 你可以在配置文件中禁用此包
  • 你可以在配置文件中添加无数个API版本
  • 除了API之外,不会影响路由

让我们开始编码!

如果你调用 /{version_number}/version,每个API都有自己的路由。如果你调用 /v2.1/hello-world,它将尝试调用v2.1,如果没有找到路由,则会搜索v1,如果v2版本也没有路由,则会回退到v1。

// laravel route file
Route::prefix('v2.1')->group(function () {
    Route::get('version', function () {
        return 'API v2.1';
    });
});

Route::prefix('v2')->group(function () {
    Route::get('version', function () {
        return 'API v2';
    });
});

Route::prefix('v1')->group(function () {
    Route::get('version', function () {
        return 'API v1';
    });

    Route::get('hello-world', function () {
        return 'Hello World!';
    });
});

安装

您可以通过Composer安装此包

composer require mbpcoder/laravel-api-versioning

用法

发布配置文件

php artisan vendor:publish --provider="MbpCoder\ApiVersioning\ApiVersioningServiceProvider"

更新日志

请参阅 更新日志 以获取更多关于最近更改的信息。

贡献

请参阅 贡献指南 以获取详细信息。

鸣谢

许可协议

MIT许可协议(MIT)。请参阅 许可文件 以获取更多信息。

Laravel包模板

此包是使用 Laravel包模板 生成的。