README

本项目修改了 Captcha for Laravel 5 和 lumen-captcha

要求

Lumen 版本 >= v5.5

预览

安装

此 Package 必须开启 Cache 才能使用，因为验证码与绑定验证码的 uuid 都保存在 Cache 中。

composer require yangbx/captcha-lumen

如何使用

在 bootstrap/app.php 中注册 Captcha Service Provider：

    $app->register(Yangbx\CaptchaLumen\CaptchaServiceProvider::class);
    class_alias('Yangbx\CaptchaLumen\Facades\Captcha','Captcha');

设置

在 bootstrap/app.php 中可以设置各种自定义类型的验证码属性，更多详细设置请查看 Captcha for Laravel 5

/**
 * captcha set
 */
config(['captcha'=>
    [
        'useful_time' => 5, //驗證碼有效時間（分鐘）
        'captcha_characters' => '2346789abcdefghjmnpqrtuxyzABCDEFGHJMNPQRTUXYZ',
        'sensitive' => false, //驗證碼是否判斷大小寫
        'login'   => [ //驗證碼樣式
            'length'    => 4, //驗證碼字數
            'width'     => 120, //圖片寬度
            'height'    => 36, //字體大小和圖片高度
            'angle'     => 10, //字體傾斜度
            'lines'     => 2, //橫線數
            'quality'   => 90, //品質
            'invert'    =>false, //反相
            'bgImage'   =>true, //背景圖
            'bgColor'   =>'#ffffff',
            'fontColors'=>['#339900','#ff3300','#9966ff','#3333ff'],//字體顏色
        ],
    ]
]);

如果不配置配置文件，默认就是default，验证码有效期为5分钟。

示例

因为 Lumen 都是无状态的 API，所以验证码图片都会绑定一个 UUID，先获得验证码的 UUID 和图片的 URL，验证时再一并发送验证码与 UUID。

生成

获得验证码：

{Domain}/captchaInfo/{type?}

type就是在 config 中定义的类型，如果不指定 type，默认为 default 样式，响应：

{
  "captchaUrl": "http://{Domain}/captcha/default/782fdc90-3406-f2a9-9573-444ea3dc4d5c",
  "captchaUuid": "782fdc90-3406-f2a9-9573-444ea3dc4d5c"
}

captchaUrl 为验证码图片的 URL，captchaUuid 为绑定验证码图片的 uuid。

验证

在发送 Request 时将验证码与 UUID 一并发送到 Server 端，在接收参数时进行验证即可：

public function checkCaptcha(Request $request, $type = 'default',$captchaUuid)
{
    $this->validate($request,[
        'captcha'=>'required|captcha:'.$captchaUuid
    ]);
    ...
}

yangbx / captcha-lumen

维护者

详细信息

README

要求

预览

安装

如何使用

设置

示例

生成

验证

链接