自定义 Laravel 表单验证规则 – 通过 API 来验证

我们所有的人都知道 Laravel 提供了一个非常方便的方式来验证表单，使用表格验证。但是你有没有发现自己需要使用第三方的 API 来验证一个表单字段？我最近在一个项目中就遇到了这个需求。

我为一个第三方服务保存了一个 API 密钥，并被要求验证该 API 密钥是否有效。我已经创建了 FormRequest 类来验证该请求。但它不允许我对第三方的 API 进行数据验证。所以我想创建一个自定义的验证规则，我可以向 API 发送一个 API 请求并验证响应。

以下是我所做的。

我们都知道 Laravel 提供了一个非常方便的方法来使用 表单验证form validation。但是你有没有发现自己需要使用第三方 API 来验证一个表单字段？我最近在一个项目中就遇到了这个需求。
基本上，我为一个第三方服务保存了一个 API 密钥，并被要求验证该 API 密钥是否有效。
我已经创建了 FormRequest 类来验证该请求。但它不允许我对第三方的 API 进行数据验证。所以我想到了创建一个自定义的验证规则，我可以向 API 发送一个 API 请求并验证响应。
以下是我所做的：

1. 创建自定义验证规则

php artisan make:rule ApiTokenRule

2. 在 ApiTokenRule 类中添加自定义规则

这个类向我们的第三方 API 发出请求，并提供我们想要验证的令牌。这个逻辑写在我们的规则类的 passes 函数中。如果我们收到 ok 响应，这意味着我们的令牌是正确的，验证通过。否则，验证失败。

<?php

namespace App\Rules;

use Illuminate\Contracts\Validation\Rule;
use Illuminate\Support\Facades\Http;

class ApiTokenRule implements Rule
{
    /**
     * 创建一个新的规则实例。
     *
     * @return void
     */
    public function __construct() {}

    /**
     * 确定验证规则是否通过。
     *
     * @param  string  $attribute
     * @param  mixed  $value
     * @return bool
     */
    public function passes($attribute, $value)
    {
        // 调用 API URL
        $response = Http::withToken($value)->post('https://myapi.url/endpoint');

        // 如果 API 返回了正确的响应，验证就会通过
        if ($response->ok()) {
            return true;
        }

        return false;
    }

    /**
     * 获取验证的错误信息。
     *
     * @return string
     */
    public function message()
    {
        return '该 API 密钥似乎是无效的。';
    }
}

3. 为 FormRequest 添加自定义规则

我们上面创建的自定义规则，应该被添加到表单请求的验证规则中。如果我们有可用的 FormRequest 类，将自定义规则添加到 rules() 函数中，如下所示：

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use App\Rules\ApiTokenRule;

class StoreCompanyRequest extends FormRequest
{
    public function authorize()
    {
        return true;
    }

    public function rules()
    {
        return [
            'name' => ['required', 'max:255'],
            'email' => ['required', 'email:rfc'],
            'api_key' => ['required', new ApiTokenRule()]
        ];
    }
}
?>

在上面的代码中，每次保存表单时，api_key 字段将根据我们的自定义规则进行验证。

本文中的所有译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。

原文地址：https://www.webspeaks.in/2023/02/create-...

译文地址：https://learnku.com/laravel/t/76118