Laravel API開発：Restful DesignとJWT認定

LaravelでRESTFUL APIを構築し、ユーザー認証にJWTを使用する方法は次のとおりです。1。Laravelのルーティングシステムを使用して、RESTFUL API操作を定義します。 2. JWT認証を処理するように、Tymon/JWT-Authパッケージをインストールして構成します。 3.ユーザーモデルにjwtsubjectインターフェイスを実装します。 4.ミドルウェアを作成して、JWTを確認します。 5.ユーザー登録とログイン関数を実装し、JWTにカスタムステートメントを追加して、アクセス許可を制御します。

導入

最新のWeb開発では、API設計とセキュリティ認証は2つの重要なリンクです。今日は、Laravelフレームワークの下でRESTFUL APIを構築する方法を詳細に調べ、JWT（JSON Webトークン）を組み合わせてユーザー認証を実現します。この記事を通して、効率的で安全なAPIを設計し、LaravelでJWTのスキルをマスターする方法を学びます。

基本的な知識のレビュー

始める前に、Restful APIとJWTの基本概念をすばやく確認しましょう。 Restful APIは、HTTPプロトコルに基づいたアーキテクチャスタイルです。さまざまなHTTPメソッド（Get、Post、Put、Deleteなど）を使用してリソースを操作します。 JWTは、JSONオブジェクトとしてエンコードされた関係者間で情報を安全に送信するコンパクトで自己完結型の方法です。

Laravelでは、強力なルーティングシステムとミドルウェアを使用してREST Ful APIを実装し、 tymon/jwt-authなどのサードパーティライブラリを使用してJWT認証を処理できます。

コアコンセプトまたは関数分析

RESTFUL APIデザインとLaravelの実装

Restful APIの設計コアは、リソースの定義と操作にあります。各リソースには一意の識別子（通常はURL）があり、HTTPメソッドを介してCRUD（作成、読み取り、更新、削除）を実行する必要があります。

Laravelでは、ルートを使用してこれらの操作を定義できます。例えば：

ルート:: get（ '/users'、 'usercontroller@index'）;
ルート:: post（ '/users'、 'usercontroller@store'）;
ルート:: get（ '/users/{id}'、 'usercontroller@show'）;
ルート:: put（ '/users/{id}'、 'usercontroller@update'）;
ルート:: delete（ '/users/{id}'、 'usercontroller@destroy'）;

この設計は明確で明確であるだけでなく、安らかな仕様にも準拠しています。 Laravelのリソースコントローラーがルーティングの定義をさらに簡素化できることは注目に値します。

ルート:: resource（ 'users'、 'usercontroller'）;

JWT認定の仕組み

JWT認証のコアは、トークンを生成および検証することです。 JWTは、ヘッダー、ペイロード、署名の3つの部分で構成されています。 Laravelでは、 tymon/jwt-authパッケージを使用して、JWTの処理を簡素化できます。

まず、 tymon/jwt-authをインストールして構成する必要があります。

作曲家には、Tymon/JWT-Authが必要です

次に、 UserモデルにJWTSubjectインターフェイスを実装します。

 Tymon \ jwtauth \ contracts \ jwtsubjectを使用します。

クラスユーザーは、AuthenticAtable Implesments jwtsubjectを拡張します
{
    // ...その他のコードパブリック関数getjwtidentifier（）
    {
        return $ this-> getKey（）;
    }

    パブリック機能getjwtcustomclaims（）
    {
        戻る [];
    }
}

次に、JWTを確認するためのミドルウェアを作成できます。

閉鎖を使用します。
Tymon \ jwtauth \ facades \ jwtauthを使用します。

クラスjwtmiddleware
{
    パブリック関数ハンドル（$ request、closure $ next）
    {
        試す {
            $ user = jwtauth :: parsetoken（） - > authenticate（）;
        } catch（例外$ e）{
            if（$ e instanceof \ tymon \ jwtauth \ exceptions \ tokeninvalidexception）{
                return response（） - > json（['status' => 'トークンは無効']）;
            } else if（$ e instanceof \ tymon \ jwtauth \ quiction \ tokenexpiredexception）{
                return Response（） - > json（['status' => 'トークンは期限切れ']）;
            }それ以外{
                return response（） - > json（['status' => '認証トークンは見つかりません']）;
            }
        }
        return $ next（$ request）;
    }
}

使用の例

基本的な使用法

ユーザー登録とログインの簡単な例を見てみましょう。

パブリック機能レジスタ（リクエスト$ request）
{
    $ validator = validator :: make（$ request-> all（）、[
        'name' => '必須|文字列|マックス：255'、
        'email' => '必須|文字列|電子メール|最大：255 |ユニーク：ユーザー'、
        'password' => '必須|文字列| min：6 |確認'、
    ]）;

    if（$ validator-> fails（））{
        return Response（） - > json（$ validator-> errors（） - > tojson（）、400）;
    }

    $ user = user :: create（[
        'name' => $ request-> get（ 'name'）、
        'email' => $ request-> get（ 'email'）、
        'password' => hash :: make（$ request-> get（ 'password'））、
    ]）;

    $ token = jwtauth :: fromuser（$ user）;

    return Response（） - > json（compact（ 'user'、 'token'）、201）;
}

パブリック関数ログイン（リクエスト$ request）
{
    $ credentials = $ request-> only（ 'email'、 'password'）;

    試す {
        if（！$ token = jwtauth :: regid（$ credentials））{
            return Response（） - > json（['error' => '無効な資格情報']、401）;
        }
    } catch（jwtexception $ e）{
        return Response（） - > json（['error' => 'はトークン'を作成できません ']、500）;
    }

    return Response（） - > json（compact（ 'token'））;
}

高度な使用

実際のアプリケーションでは、ユーザーの役割など、JWTにカスタムクレーム（クレーム）を追加する必要がある場合があります。

パブリック機能getjwtcustomclaims（）
{
    戻る [
        「役割」=> $これ - >役割、
    ];
}

このようにして、JWTを検証するとき、私たちは役割に従ってユーザーの許可を制御できます。

パブリック関数ハンドル（$ request、closure $ next）
{
    $ user = jwtauth :: parsetoken（） - > authenticate（）;
    if（$ user-> role！== 'admin'）{
        return Response（） - > json（['error' => 'unauthorized']、403）;
    }
    return $ next（$ request）;
}

一般的なエラーとデバッグのヒント

JWTを使用する場合の一般的なエラーには、トークンの有効期限、トークン無効、またはトークンの欠落が含まれます。デバッグは、次の方法で行うことができます。

• トークンが生成され、正しく渡されるかどうかを確認してください
• トークンの有効期限の問題を回避するために、サーバー時間がクライアント時間と同期していることを確認してください
• tymon/jwt-authが提供するデバッグツールを使用して、トークンの詳細情報を表示します

パフォーマンスの最適化とベストプラクティス

JWTとRestful APIを最適化する場合、次のポイントを考慮する必要があります。

• トークンライフサイクル管理：頻繁なトークンリフレッシュを避け、セキュリティを確保するために、アプリケーションに応じて合理的なトークンの有効期限を設定します。
• キャッシュポリシー：頻繁にアクセスされるリソースの場合、Laravelのキャッシュメカニズムを使用して応答速度を向上させることができます。
• コードの読みやすさとメンテナンス：Laravelの命名規則とコードスタイルをフォローして、コードが理解し、維持できることを確認してください。

実際のプロジェクトでは、問題に遭遇しました。トークンの有効期限が短すぎるため、ユーザーは再びログインする必要があるため、ユーザーエクスペリエンスに影響します。トークンの有効期限を調整し、トークン自動更新メカニズムを実装することにより、この問題をうまく解決しました。

要するに、LaravelとJWTを組み合わせて、Restful APIを構築するための強力で柔軟なソリューションを提供します。この記事の紹介と例を通じて、これらのテクノロジーをよりよく理解し、適用できるはずです。これらの経験と提案が、実際のプロジェクトで安心するのに役立つことを願っています。

以上がLaravel API開発：Restful DesignとJWT認定の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。