Laravel 開発: Laravel Passport を使用して API 認証を実装するにはどうすればよいですか?

Laravel は、開発者が効率的な Web アプリケーションを簡単に構築できるように設計されたオープンソースの PHP Web アプリケーション フレームワークです。 Laravel Passport は Laravel フレームワークの一部であり、OAuth2 プロトコルを実装し、API 開発を強力にサポートする認証サーバーです。この記事では、Laravel Passportを使用してAPI認証を実装する方法について説明します。

1. Laravel Passport のインストール

Laravel Passport を使用する前に、まずインストールする必要があります。 Laravel Passport は、次のコマンドを実行してインストールできます:

composer require laravel/passport

インストールが完了したら、php Artisan Migrate コマンドを実行して、必要なデータ テーブルを作成する必要もあります。

2. 認証ミドルウェアの構成

API 認証に Laravel Passport を使用するには、Laravel の認証ミドルウェアと組み合わせて使用​​する必要があります。 API グループに対応する認証ミドルウェアを app/Http/Kernel.php ファイルに追加できます。

protected $middlewareGroups = [
    'api' => [
        'throttle:60,1',
        IlluminateRoutingMiddlewareSubstituteBindings::class,
        LaravelPassportHttpMiddlewareCreateFreshApiToken::class,
    ],
];

その中で、CreateFreshApiToken ミドルウェアが使用されます。各リクエストで API トークンをチェックインし、必要に応じて自動的に更新します。

3. API 認証ルートの作成

次に、API に対応する認証ルートを作成する必要があります。次のルートを routes/api.php ファイルに追加できます。

Route::post('login', 'APIAuthController@login');
Route::post('register', 'APIAuthController@register');

Route::group(['middleware' => ['auth:api']], function() {
    Route::get('details', 'APIAuthController@details');
    // 添加更多需要登录才能访问的API路由
});

上記のコードでは、auth:api ミドルウェアは、認証されているユーザーのみがこれらのルートにアクセスできます。 AuthController は、後で作成するコントローラーで、認証と API ルーティングを処理するロジックが含まれています。

4. API 認証コントローラーの作成

次に、API 認証とルーティングを処理するコントローラーを作成する必要があります。 AuthController は、次のコマンドを使用して作成できます:

php artisan make:controller API/AuthController

AuthController には次のメソッドが含まれている必要があります:

use IlluminateHttpRequest;
use IlluminateSupportFacadesAuth;
use IlluminateSupportFacadesValidator;
use AppUser;

class AuthController extends Controller
{
    /**
     * 用户注册
     *
     * @param  IlluminateHttpRequest  $request
     * @return IlluminateHttpResponse
     */
    public function register(Request $request)
    {
        $validator = Validator::make($request->all(), [
            'name' => 'required|string|max:255',
            'email' => 'required|string|email|unique:users',
            'password' => 'required|string|min:6',
        ]);

        if ($validator->fails()){
            return response(['errors'=>$validator->errors()->all()], 400);
        }

        $request['password'] = bcrypt($request['password']);
        $user = User::create($request->toArray());
        $token = $user->createToken('MyApp')->accessToken;
        return response(['token' => $token], 200);
    }

    /**
     * 用户登录
     *
     * @param  IlluminateHttpRequest  $request
     * @return IlluminateHttpResponse
     */
    public function login(Request $request)
    {
        $validator = Validator::make($request->all(), [
            'email' => 'required|string|email',
            'password' => 'required|string',
        ]);

        if ($validator->fails()) {
            return response(['errors'=>$validator->errors()->all()], 400);
        }

        if (!Auth::attempt(['email' => $request['email'], 'password' => $request['password']])) {
            return response(['message' => 'Invalid login credentials'], 400);
        }

        $user = $request->user();
        $token = $user->createToken('MyApp')->accessToken;
        return response(['token' => $token], 200);
    }

    /**
     * 获取用户详细信息
     *
     * @param  IlluminateHttpRequest  $request
     * @return IlluminateHttpResponse
     */
    public function details(Request $request)
    {
        return response()->json(['user' => $request->user()], 200);
    }
}

register() メソッド ユーザーの登録には login() メソッド、ユーザーのログインには login() メソッド、ログインしているユーザーの詳細情報の取得には details() メソッドを使用します。 register() メソッドと

login()

メソッドは、認証されたユーザーの新しい API トークンを作成し、クライアントに返すことに注意してください。

API 認証のテスト

ユーザー名とパスワードを送信して API 認証をテストできます。 Postman やcurlなどのツールを使用して次のコマンドを実行できます:

curl -X POST 
  http://your-app-url/api/login 
  -H 'content-type: application/json' 
  -d '{
    "email": "user@example.com",
    "password": "password"
}'

ユーザー名とパスワードが正しい場合、API トークンを含む応答が受信されます:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImU4YmI2Njk0MGEyNmIzY2Q2ZmY4M2Q3MjQ5ZjgzODE1MTI2ZmRkMDIyM2YyMzVmOGZmNjhlOWM5NGU2Mzk4ZTU3ZWZiMDJhNmQyZmRlZjA2In0.eyJhdWQiOiIxIiwianRpIjoiZThiYjY2OTAwZTI2YjNjZDZmZjgzZDcyNDlmODM4MTUxMjZmZGQwMjIzZjIzNWY4ZmY2OGU5Yzk0ZTYzOThlNTdlZmIwMmE2ZDJmZGVmMDYiLCJpYXQiOjE2Mjg5NDM3NzQsIm5iZiI6MTYyODk0Mzc3NCwiZXhwIjoxNjMxMDQ5Nzc0LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.toR762TgsNDarQZs6azl-jg-tP2996vzUc-LOQB90Twcb0Y3BC5vrd3jDW70QQw961MwV_sFrU1dhyKLMN76lG6B03zv6GjU6tLHyrqQi88t0clSrVupAcaQHOAB0gGLBRAOc5Ql1z9CHXx8f_FkA3RVC4htHNTk_r0mM-szWcf1sRONQYaARPDFl7ZJwj1_wYB7M6dcpiEDDhpyzmRFPv7pYyX8805BL4yg6z-Kmxc-DW4GSS4NTBxnctwGPf9w8fYc2zJGHXmT6OtqVjuqKDdFQgxIQhEkeSldBZmzTIPIR_tTa8Ub3Cxlx69zAfJTHosXwPYQOO03LBJwNVdjeLIkKgQK1PcAXD2kN4-RuyTEMXYNQ0wRGaHIb3vxwqVdjrrVE9yrDMIpAPRgzFwzXbJWvKmxzZpFTUz9RvIqUFt2zNbIG5kLOUyvmKIqO-aTISCT0wu0T0ZEq-DpXJ7-C6z-M0cJJP37y7eV4jdAMx7yD9jT85Knv4_hjLyKvF4We5DSSOYjeIVoq3XHNJdmYJ7X3ph6Ko1CfdtVKNVf20Vx8Z_Zi-pe9bTY0n-tSkwDvVXpVOrb3BOalq7MbOpTe8Klf9uZ_ZIDqTlTnrYV_oh_5isrImv7r8D1NX1G4p9jRcI16MEFDE"
}

次に、別のコマンド認証が必要なルートにアクセスするには: <pre class='brush:bash;toolbar:false;'>curl -X GET http://your-app-url/api/details -H 'authorization: Bearer &lt;token&gt;'</pre> 上記のコマンドの

d6fb5a6237ab04b68d3c67881a9080fa

を、前の手順で取得した API トークンに置き換えます。トークンが有効な場合、認証済みの応答が返されます。

6. {
       "user": {
           "id": 1,
           "name": "User",
           "email": "user@example.com",
           "email_verified_at": null,
           "created_at": "2021-08-13T02:58:04.000000Z",
           "updated_at": "2021-08-13T02:58:04.000000Z"
       }
   }

概要

### この記事では、Laravel Passport を使用して API 認証を実装する方法について説明しました。 Laravel Passport を使用すると、強力な認証サポートを Web API に簡単に追加でき、ユーザーデータの安全性を高めることができます。 Laravel Passport は、API アクセス トークン管理や OAuth2 クライアント管理などの他の強力な機能も提供します。 Laravel 開発者の方は、Laravel Passport についてさらに学び、次の Web プロジェクトで使用してください。 ###

以上がLaravel 開発: Laravel Passport を使用して API 認証を実装するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。