LaravelでAPI認証にSanctumを使用する方法は？

Sanctumをインストールし、移行を実行します。 2. Sanctumミドルウェアを追加して、スパ認証をサポートします。 3.ユーザーモデルでhasapitokens機能を使用します。 4。CreateToken（）メソッドを介してAPIトークンを発行します。 5.クライアントは、リクエストを行うために認可ヘッダーにBEARERトークンを携帯しています。 6.認証を使用したルートを保護します：Sanctum Middleware; 7。CurrentAccesStoken（） - > delete（）を呼び出して、現在のトークンからログアウトします。 8.オプションで、能力をトークンに割り当てて、微調整された許可制御を実現します。 Laravel Sanctumは、SPA、モバイルアプリケーション、または内部APIに適した軽量でシンプルで使いやすいAPIトークン認証ソリューションであり、複雑なOAuthプロセスなしでは箱から出して使用できます。

LaravelでAPI認証にSanctumを使用することは、特にSPA（シングルページアプリ）、モバイルアプリ、または単純なAPIのトークンベースの認証を処理するための軽量で簡単な方法です。 SanctumはOAuthを使用しません。代わりに、リクエストの認証に使用できるAPIトークンを発行します。

Laravel Sanctumを段階的にセットアップして使用する方法は次のとおりです。

1. Laravel Sanctumをインストールします

まず、Composerを介してSanctumをインストールします。

作曲家にはLaravel/Sanctumが必要です

次に、Sanctum構成と移行ファイルを公開します。

 PHP Artisan Vendor：Publish -Provider = "Laravel \ Sanctum \ SanctumserviceProvider"

これによりdatabase/migrationsの移行ファイルとconfig/sanctum.phpでconfigファイルが作成されます。

次に、移行を実行してpersonal_access_tokensテーブルを作成します。

 PHPの職人が移行します

2. Sanctumミドルウェアを追加します

Sanctumはミドルウェアを使用してAPIリクエストを認証します。 SANCTUMをSANCTUMを使用してStateful SPA認証を使用している場合は、 apiミドルウェアグループにSanctumのミドルウェアを含める必要があります。

app/Http/Kernel.phpを開き、次のミドルウェアがapiグループに追加されていることを確認してください。

 'API' => [
    \ laravel \ sanctum \ http \ middleware \ sersefrontendrequestsarestateful :: class、
    「スロットル：API」、
    \ Illuminate \ Routing \ Middleware \ sultiftbindings :: class、
]、、

このミドルウェアは、スパのセッションベースの認証を処理し、必要に応じてトークン認証に戻ります。

注：単純なトークンベースのAPI認証（モバイルまたはサードパーティのクライアントなど）にSanctumを使用している場合、セッション状態は必要ない場合があります。その場合、このミドルウェアをスキップして、トークンのみの認証を使用します。

3.ユーザーモデルにhasapitokensの特性を使用させます

Userモデル（または認証可能なモデル）が、Sanctumが提供するHasApiTokens特性を使用していることを確認してください。

 laravel \ sanctum \ hasapitokensを使用します。

クラスユーザーはAuthenticAtableを拡張します
{
    hasapitokens、hasfactory、notifiableを使用します。
}

これにより、 createToken()などのメソッドがAPIトークンを生成します。

4. APIトークンを発行します

APIトークンを発行するには、ユーザーインスタンスでcreateToken()メソッドを呼び出します。たとえば、ログインコントローラーで：

 Illuminate \ http \ requestを使用します。
Illuminate \ support \ facades \ authを使用します。

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

    if（auth :: regide（$ credentials））{
        $ user = auth :: user（）;
        $ token = $ user-> createToken（ 'api-token'） - > plaintexttoken;

        return Response（） - > json（['token' => $ token]）;
    }

    return Response（） - > json（['error' => 'unauthorized']、401）;
}

createToken()メソッドは、 NewAccessTokenオブジェクトを返します。 plainTextTokenを使用して、クライアントにトークン値を取得します。

トークンが初めて作成されたとき、Sanctumはデータベースにハッシュバージョンを保存し、一度だけプレーンテキストバージョンを返します。

5。APIリクエストを認証します

クライアントがトークンを持っていると、 AuthorizationヘッダーにBearerトークンとして含める必要があります。

承認：BEARER 1 | ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890

auth:sanctum Guardを使用してルートを保護する場合、Sanctumはこのトークンを自動的にチェックします。

6.聖域でルートを保護します

routes/api.phpでは、 auth:sanctumミドルウェア：

 Illuminate \ http \ requestを使用します。

ルート::ミドルウェア（ 'auth：sanctum'） - > get（ '/user'、function（request $ request）{
    $ request-> user（）を返します。
}）;

このミドルウェアの背後にあるルートには、有効なAPIトークンが必要です。

グループに適用することもできます。

ルート::ミドルウェア（ 'auth：sanctum'） - > group（）{{
    ルート:: get（ '/user'、fn（request $ request）=> $ request-> user（））;
    ルート:: post（ '/logout'、[authcontroller :: class、 'logout']）;
}）;

7。Tokens（ログアウト）

現在のトークンをログアウトして取り消すには：

 Illuminate \ http \ requestを使用します。

パブリック機能ログアウト（リクエスト$ request）
{
    $ request-> user（） - > currentAccessToken（） - > delete（）;

    return response（） - > json（['message' => 'logged out']）;
}

すべてのトークンを取り消したい場合：

 $ request-> user（） - > tokens（） - > delete（）;

8。トークン能力（オプション）

Sanctumはトークン権限（「能力」と呼ばれる）をサポートしています。トークンを作成するときは、能力を指定します。

 $ token = $ user-> createToken（ 'api-token'、['read'、 'write']） - > plaintexttoken;

次に、ミドルウェアまたはコントローラーの能力を確認します。

 if（$ request-> user（） - > tokencan（ 'write'））{
    //書き込み操作を許可します
}

ミドルウェアを使用して能力に基づいてルートを保護します。

ルート::ミドルウェア（['auth：sanctum'、 'ability：read']） - > get（ '/data'、fn（）=> ...）;

まとめ

• Sanctumをインストールし、移行を実行します。
• スパサポートにミドルウェアを追加します（必要に応じて）。
• ユーザーモデルでHasApiTokens使用します。
• createToken()でトークンを生成します。
• Authorization: Bearer 。
• auth:sanctumミドルウェアはルートを保護します。
• オプションで、細かいアクセスにトークン機能を使用します。

Sanctumは、OAuthの複雑さのない単純なトークンベースのAUTHに最適です。完全なOAuthフローを必要としない内部API、モバイルアプリ、またはスパに最適です。

基本的にそれだけです - 軽量で、セットアップが簡単で、箱から出してうまく機能します。

以上がLaravelでAPI認証にSanctumを使用する方法は？の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。