在这篇文章中,我将向您展示如何在 laravel 11 应用程序中使用 JWT 令牌进行 API 身份验证。我们将从头开始学习 API、JWT REST API 和 Laravel JWT 身份验证,并创建一个示例 API。
什么是API
?
API(应用程序编程接口)只是两个或多个计算机程序之间的一种通信方式。
API 还用于 Web 和移动应用程序开发;因此,构建 REST API 对于任何 Web 和移动应用程序开发人员都非常重要。
什么是JWT
?
JWT 代表 JSON Web 令牌,它是一个开放标准(RFC 7519),它定义了一种紧凑且自包含的方式,用于将信息作为 JSON 对象在各方之间安全地传输。JWT 通常用于授权、信息交换等。
在此示例中,我们将安装 Laravel 11 应用程序。然后,我们将安装api
。然后我们将使用php-open-source-saver/jwt-auth
包来使用JWT
。之后,我们将创建用于用户身份验证的 register、login、refresh、profile 和 logout API。那么,让我们按照以下步骤逐步完成此示例:
按照以下几个步骤在 laravel 11 应用程序中创建一个 restful API 示例。
第一步: 安装 Laravel 11
如果已经安装可以忽略;如果您尚未创建Laravel
应用程序,则可以继续执行以下命令:
composer create-project laravel/laravel example-app
第二步:启用 API 并更新身份验证
默认情况下,laravel 11 API 路由在 laravel 11 中未启用。我们将使用以下命令启用 API:
php artisan install:api
现在,如果用户未进行身份验证,则exception
将调用,我们将返回json
响应。那么,让我们更新app.php
文件。
bootstrap/app.php
<?php
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Http\Request;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
api: __DIR__.'/../routes/api.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware) {
//
})
->withExceptions(function (Exceptions $exceptions) {
$exceptions->render(function (AuthenticationException $e, Request $request) {
if ($request->is('api/*')) {
return response()->json([
'message' => $e->getMessage(),
], 401);
}
});
})->create();
安装和设置 JWT Auth 软件包
在此步骤中,我们将安装 php-open-source-saver/jwt-auth composer 包。
composer require php-open-source-saver/jwt-auth
包配置文件:
php artisan vendor:publish --provider="PHPOpenSourceSaver\JWTAuth\Providers\LaravelServiceProvider"
接下来,生成