単純さと明確さを得るには、URLバージョン化（ /API /V1など）を使用します。 2。ルート:: routes/api.phpのprefix（）を使用したグループ版のルート。 3.バージョンごとにコントローラー、リソース、トランスを整理します。 4. Laravel APIリソースを使用して、バージョンごとに一貫した応答構(gòu)造を維持します。 5.オプションでは、ミドルウェアを使用したヘッダーベースのバージョンを使用しますが、複雑さを追加します。 6.警告ヘッダーの追加、使用のロギング、タイムラインの通信、安全の場(chǎng)合にのみ削除することにより、古いバージョンを優(yōu)雅に非難します。早期かつ明確にバージョン化することにより、後方互換性が明確に保証され、クライアントが予期せずに壊すことができなくなります。

Laravel APIのバージョン化は、変更を変更するときに後方互換性を維持するためのベストプラクティスです。効果的かつきれいに行う方法は次のとおりです。

1. URLまたはヘッダーバージョンの使用（URLはよりシンプルです）

最も一般的で簡(jiǎn)単なアプローチは、APIバージョンがルートの一部であるURLバージョン化です。

 /API/V1/ユーザー
/API/V2/ユーザー

Laravelで、 routes/api.phpでバージョンされたルートを定義します：

 // routes/api.php

// V1エンドポイント
ルート::プレフィックス（ 'v1'） - > group（function（）{
    ルート:: apiresource（ 'users'、[v1 \ usercontroller :: class]）;
}）;

// V2エンドポイント
ルート::プレフィックス（ 'v2'） - > group（function（）{{
    ルート:: apiresource（ 'users'、[v2 \ usercontroller :: class]）;
}）;

これにより、ルートが隔離され、クライアントが使用しているバージョンを明確にします。

?ヒント：必要に応じてミドルウェアを備えたルートプレフィックスを使用します（たとえば、Auth、Throttling）。

2。バージョンごとにコントローラーとリソースを整理します

複數(shù)のバージョンをきれいにサポートするためにアプリを構(gòu)成します。

アプリ/
p
    └└。colonters/
        pi/ api/
            ├·ックス
            │├│。-usercontroller.php
            ││·ックスン/─トランスフォーマー/
            └）/ v2/
                ├） usercontroller.php
                └└）/トランス/

各バージョンには、獨(dú)自のコントローラー、リクエストクラス、およびリソース変圧器があります（APIリソースを使用する場(chǎng)合）。

例えば：

 // app \ http \ controllers \ api \ v1 \ usercontroller.php
名前空間app \ http \ controllers \ api \ v1;

クラスusercontrollerはコントローラーを拡張します
{
    パブリック関數(shù)インデックス（）
     {
         userresource :: collection（user :: all（））;
     }
}

 // app \ http \ controllers \ api \ v2 \ usercontroller.php
名前空間app \ http \ controllers \ api \ v2;

クラスusercontrollerはコントローラーを拡張します
{
    パブリック関數(shù)インデックス（）
    {
        return userv2resource :: collection（user :: with（ 'profile'） - > get（））;
    }
}

3.応答の一貫性にAPIリソースを使用します

LaravelのAPIリソースは、バージョンごとに一貫して応答のフォーマットをヘルプします。

 PHP Artisan Make：Resource V1/UserRersource
PHP Artisan Make：Resource V2/Userv2Resource

これにより、基礎(chǔ)となるデータが変更されたとしても、各バージョンは予想される構(gòu)造を返します。

4。オプション：ヘッダーベースのバージョン化

ヘッダーを介したバージョン化を好む人もいます（例Accept: application/vnd.myapp.v2 json ）。純粋主義者にとっては「安らかな」ものですが、テストしてデバッグすることは困難です。

このルートに行く場(chǎng)合は、ミドルウェアを使用して、それに応じてヘッダーAcceptてルートを検査しますが、これにより複雑さが追加されます。ほとんどのアプリでは、 URLバージョンの管理はより明確で管理が容易です。

5。古いバージョンを優(yōu)雅に非難します

バージョンを廃止するとき：

• Deprecatedヘッダーを追加します
• 古いバージョンのログの使用
• API消費(fèi)者にタイムラインを伝えます
• 最終的には、安全な場(chǎng)合はルート/コントローラーを取り外します

非推奨バージョンにフラグを立てるためのミドルウェアの例：

 // app/http/middleware/checkapiversion.php
パブリック関數(shù)ハンドル（$ request、$ next、$バージョン）
{
    if（$ version === 'v1'）{
        ヘッダー（ 'x-api-deprecated：true'）;
        ヘッダー（ 'X-API-WARN：V1は2025-01-01'に非推奨）;
    }

    return $ next（$ request）;
}

ルートグループに適用してください。

ルート::プレフィックス（ 'v1'） - >ミドルウェア（ 'check.api.version：v1'） - > group（function（）{
    // ...
}）;

まとめ

• urlバージョン化（ /api/v1/...を使用します）
• prefix('v1')
• versionバージョンごとに個(gè)別のコントローラーとリソース
• respons応答フォーマットを安定させます
• ?警告が付いた古いバージョンを非難します

派手ではありませんが、信頼性が高く、拡張しやすいです。最も成功したAPI（ストライプ、Githubなど）は、同様のパターンを使用します。

基本的に：バージョンの早い段階、バージョンは明らかに、クライアントを予期せずに破らないでください。

以上がLaravel APIにバージョンする方法は？の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。