Laravel Sanctum 使用教程

Laravel Sanctum 使用教程

sanctumLaravel Sanctum provides a featherweight authentication system for SPAs and simple APIs.项目地址:https://gitcode.com/gh_mirrors/sa/sanctum

项目介绍

Laravel Sanctum 是一个轻量级的身份验证系统，主要用于 SPA（单页应用程序）、移动应用程序和简单的、基于令牌的 API。Sanctum 允许每个用户为他们的应用程序创建多个 API 令牌。这些令牌可以被授予特定权限（例如：发布、更新、删除）。

项目快速启动

安装

首先，通过 Composer 安装 Sanctum：

composer require laravel/sanctum

接下来，发布 Sanctum 的配置文件和迁移文件：

php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"

运行数据库迁移：

php artisan migrate

配置

在 app/Models/User.php 文件中，使用 HasApiTokens trait：

use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens, Notifiable;
}

创建 API 令牌

在控制器中，你可以为用户创建 API 令牌：

use Illuminate\Http\Request;

Route::post('/tokens/create', function (Request $request) {
    $token = $request->user()->createToken($request->token_name);

    return ['token' => $token->plainTextToken];
});

应用案例和最佳实践

SPA 认证

对于单页应用程序，Sanctum 使用 Laravel 的 web 认证 guard 来处理会话认证。确保你的 SPA 和 API 在同一个域名下，或者配置跨域资源共享（CORS）和会话域。

移动应用认证

对于移动应用程序，你可以使用 Sanctum 提供的 API 令牌。用户登录后，生成一个 API 令牌并返回给客户端。客户端在每个请求的头部携带这个令牌。

典型生态项目

Laravel Jetstream

Laravel Jetstream 是一个官方的 Laravel 应用程序脚手架，它集成了 Sanctum 用于 API 认证和会话管理。Jetstream 提供了完整的用户注册、登录、邮箱验证、双因素认证等功能。

Laravel Fortify

Laravel Fortify 是一个无头认证后端，可以与 Sanctum 结合使用，提供完整的认证解决方案，包括登录、注册、密码重置等功能。

通过以上步骤，你可以快速上手并使用 Laravel Sanctum 进行 API 认证和会话管理。结合 Laravel Jetstream 和 Fortify，可以构建出功能强大的现代应用程序。

sanctumLaravel Sanctum provides a featherweight authentication system for SPAs and simple APIs.项目地址:https://gitcode.com/gh_mirrors/sa/sanctum