coolcode / authapi
使用 sanctum 进行 API 认证
v1.0.0
2024-09-18 01:32 UTC
Requires
- laravel/sanctum: 4.x-dev
README
coolcode/authapi
是一个 Laravel 包,简化了使用 Laravel Sanctum 的 API 认证。此包提供了一套端点,用于用户注册、登录和登出功能,支持基于令牌的认证。
安装
-
通过 Composer 安装此包
composer require coolcode/authapi
-
发布 Sanctum 迁移
php artisan vendor:publish --tag=sanctum-migrations
-
运行迁移
php artisan migrate
-
最后,当用户通过您的 API 进行认证时,颁发 Laravel Sanctum 令牌。
API 端点
1. 注册
端点: /api/register
方法: POST
头部信息
Accept: application/json
Content-Type: application/json
请求体 (表单数据)
描述
在系统中注册新用户。
2. 登录
端点: /api/login
方法: POST
头部信息
Accept: application/json
Content-Type: application/json
请求体 (表单数据)
描述
验证用户并颁发用于未来 API 请求的 Bearer 令牌。令牌存储在环境变量 token
中。
3. 登出
端点: /api/logout
方法: POST
头部信息
Accept: application/json
Content-Type: application/json
Authorization: Bearer {{token}}
描述
注销已认证的用户并使 Bearer 令牌无效。
用法
安装并设置好此包后,您可以使用这些端点在 Postman 收藏夹或任何 API 客户端中处理用户认证。
Postman 示例
- 使用 注册 API 注册用户。
- 使用 登录 API 获取 Bearer 令牌。
- 将令牌设置在您的环境变量中,以便用于未来的认证请求。
- 使用 登出 API 注销用户。
许可证
此包是开源软件,根据 MIT 许可证 授权。