Laravel OTP 项目使用教程

石菱格Maureen

于 2024-08-27 09:19:57 发布

阅读量463

点赞数 18

本文链接：https://blog.csdn.net/gitblog_01063/article/details/141590319

版权

Laravel OTP 项目使用教程

laravel-otpThis package provides convenient methods for sending and validating OTP notifications to users for authentication.项目地址:https://gitcode.com/gh_mirrors/lar/laravel-otp

项目介绍

Laravel OTP 是一个为 Laravel 框架设计的 OTP（一次性密码）生成和验证包。这个包可以帮助开发者轻松地在 Laravel 应用中集成 OTP 功能，无需编写大量重复代码。通过简单的配置和命令，开发者可以快速生成 OTP 类，并在应用中实现 OTP 的生成、发送和验证。

项目快速启动

安装

首先，通过 Composer 安装 Laravel OTP 包：

composer require mohammad-fouladgar/laravel-otp

发布配置文件

安装完成后，发布配置文件：

php artisan vendor:publish --provider="MohammadFouladgar\OTP\ServiceProvider"

生成 OTP 类

使用以下命令生成一个新的 OTP 类：

php artisan make:otp UserRegistrationOtp

生成的 OTP 类将位于 app/OTP 目录下。

配置路由

在 routes/web.php 或 routes/api.php 中配置 OTP 相关的路由：

use MohammadFouladgar\OTP\Facades\OTP;

Route::post('/otp/send', function (Request $request) {
    $request->validate([
        'email' => ['required', 'string', 'email', 'max:255'],
    ]);

    $otp = OTP::generate($request->email);

    if ($otp['status'] === OTP::OTP_SENT) {
        return __($otp['status']);
    }

    abort(403, __($otp['status']));
});

Route::post('/otp/verify', function (Request $request) {
    $request->validate([
        'email' => ['required', 'string', 'email', 'max:255'],
        'code' => ['required', 'string', 'max:6'],
    ]);

    $otp = OTP::verify($request->email, $request->code);

    if ($otp['status'] === OTP::OTP_VERIFIED) {
        return __($otp['status']);
    }

    abort(403, __($otp['status']));
});