tmkzmu/fortress

处理Laravel应用程序中的API的基本认证操作

v1.0.5 2022-04-21 13:03 UTC

This package is auto-updated.

Last update: 2024-09-21 18:46:08 UTC


README

PHP from Packagist Laravel version

此软件包提供了一种简单优雅的方式来创建Laravel应用程序注册和授权API所需的所有必要端点。

  • 用户注册
  • 登录
  • 电子邮件验证
  • 更新
  • 密码重置

安装

从composer安装包

composer require tmkzmu/fortress

发布操作

php artisan vendor:publish --provider="Tmkzmu\Fortress\FortressServiceProvider"

此命令将所有操作类发布到 app\Actions\Fortress 文件夹。有几个操作

  • 注册
  • 登录
  • 电子邮件验证
  • 密码重置
  • 更新密码
  • 更新个人资料

它们都有自己的默认逻辑。其余(端点、控制器、迁移)由软件包提供。

运行迁移

执行 php artisan migrate 以运行迁移。

添加特质

如果您想使用电子邮件验证,请将 Tmkzmu\Fortress\Traits\VerifyEmailTrait 特质和Laravel的 MustVerifyEmail 接口添加到您的 User 模型。

配置

配置文件(fortress.php)存储在 config 文件夹中。

有几个配置

  • features - 开启的操作数组。
  • controller_class - 处理所有请求的默认控制器。如果您想使用自己的控制器,请在此处设置类名并实现接口 Tmkzmu\Fortress\Controllers\FortressControllerInterface
  • routes - 路由的几个配置
    • prefix - 定义路由的前缀(例如 api/v1
    • middleware - 所有路由的中间件
    • auth_middleware - 仅受保护端点的中间件名称
    • throttle - 对端点请求进行节流
      • 登录
      • 电子邮件验证
      • 重置密码
    • paths - 操作的端点路径
  • 认证
    • verification_expire - 邮件验证URL的过期时间
  • emails - 邮件端点配置
    • callback_url - 邮件操作的URL
    • email_verification_prefix - 电子邮件验证端点的路径
    • password_reset_prefix- 密码重置端点的路径

测试

所有端点都已测试。您可以通过扩展测试类 Tmkzmu\Fortress\Feature\FortressTest 来使用软件包测试。

许可证

MIT