Web テクノロジーの発展とアプリケーション シナリオの継続的な拡大に伴い、API は多くの企業(yè)や開発者にとって重要な技術(shù)コンポーネントとなり、バージョン管理も API 設(shè)計(jì)の仕様の 1 つになりました。この記事では、ThinkPHP6 フレームワークで API バージョン管理を?qū)g裝する方法を紹介します。

1. バージョン管理について理解する

バージョン管理は、コードまたはドキュメントの変更履歴を維持する方法です。 API 設(shè)計(jì)では、バージョン管理は、いかなる狀況でも API に下位互換性がないことを保証する重要な方法です。

バージョン管理には通常、次のタイプがあります。

• URL バージョン管理: API バージョンを區(qū)別するために、異なるバージョンの URL を使用します。
• ヘッダー バージョン管理: HTTP ヘッダーを使用して API バージョンを區(qū)別します。
• クエリ パラメーターのバージョン管理: クエリ パラメーターを使用して API バージョンを指定します。

ThinkPHP6 では、URL バージョン管理を使用して API バージョン管理を?qū)g裝します。

2. バージョン管理ミドルウェアの作成

まず、API バージョンを処理および検証するためのミドルウェアを作成する必要があります。 ThinkPHP6 では、次のコマンドを使用してミドルウェアを作成できます。

php think make:middleware VersionControl

次に、API バージョンに応じて handle メソッドにバージョン管理ロジックを?qū)g裝します。 URL のバージョン管理を例に挙げると、URL のプレフィックスを使用して API バージョンを指定できます。たとえば、user API のバージョン 1 にアクセスするには、/v1/user を使用します。

ミドルウェアのコードは次のとおりです:

<?php
declare (strict_types = 1);

namespace appmiddleware;

use thinkRequest;
use thinkResponse;

class VersionControl
{
    public function handle(Request $request, Closure $next)
    {
        $version = $request->param('version'); // 獲取版本號(hào)
        if (!$this->isValidVersion($version)) {
            $response = new Response();
            $response->code(400);
            $response->data('Invalid Version'); // 返回錯(cuò)誤響應(yīng)
            return $response;
        } else {
            // 正常請(qǐng)求
            return $next($request);
        }
    }

    private function isValidVersion($version)
    {
        // 驗(yàn)證版本號(hào)是否有效，這里可以根據(jù)自己的業(yè)務(wù)規(guī)則進(jìn)行驗(yàn)證
        switch ($version) {
            case 'v1':
            case 'v2':
                return true;
            default:
                return false;
        }
    }
}

3. バージョン管理ミドルウェアの登録

ミドルウェアを作成した後、アプリケーションに登録する必要があります。リクエストを傍受して処理するため。アプリケーションの middleware.php ファイルにミドルウェア クラスの完全名を追加し、ミドルウェアによって処理される必要があるルート プレフィックスを指定します。

return [
    'VersionControl' => ppmiddlewareVersionControl::class,
];

// 路由中間件
return [
    'api/:version/user' => 'api/:version.User/index',
    'api/:version/order' => 'api/:version.Order/index',
    'api/:version/product' => 'api/:version.Product/index',
]->middleware(['VersionControl']);

4. バージョン付き API の実裝

ここで、バージョン番號(hào)を含む API を?qū)g裝できます。バージョン番號(hào)コントローラーと対応するメソッドを作成し、メソッドにビジネス ロジックを?qū)g裝します。

たとえば、コントローラー app picontroller 1User.php では、API のバージョン管理メソッドを?qū)g裝できます:

<?php
declare (strict_types = 1);

namespace apppicontroller1;

use thinkesponseJson;

class User
{
    public function index(): Json
    {
        return json(['message' => 'This is user API V1']);
    }
}

app picontroller 2User。 php で、API バージョン 2 のコントローラー メソッドを?qū)g裝します:

<?php
declare (strict_types = 1);

namespace apppicontroller2;

use thinkesponseJson;

class User
{
    public function index(): Json
    {
        return json(['message' => 'This is user API V2']);
    }
}

これで、ブラウザーでさまざまなバージョンのユーザー API にアクセスできるようになります:

• http ://localhost/api/v1/user：return{"message":"これはユーザー API V1 です"}
• http://localhost/api /v2/user: 戻り値 {"メッセージ":"これはユーザー API V2 です"}

5. 概要 ##この記事では、ThinkPHP6 で API のバージョン管理を?qū)g裝する方法を、主に URL のバージョン管理を使用して、ミドルウェアの作成、ミドルウェアとバージョン管理された API の登録によるバージョン管理の実裝方法を紹介します。

以上がThinkPHP6 で API バージョン管理を?qū)g裝するにはどうすればよいですか?の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國語 Web サイトの他の関連記事を參照してください。