使用laravel-webhook-server处理Laravel应用中的Webhook

使用laravel-webhook-server处理Laravel应用中的Webhook

laravel-webhook-serverSend webhooks from Laravel apps项目地址:https://gitcode.com/gh_mirrors/la/laravel-webhook-server

目录结构及其简介

在使用composer require spatie/laravel-webhook-server安装laravel-webhook-server后，你的项目将包含以下关键目录结构:

• config
  包含项目的配置文件，如webhook-server.php, 这里定义了Webhook接收端点以及各种参数.

• vendor/spaceit/
  包括第三方包的源代码. spatie/laravel-webhook-server 的代码会存放在此处.

• tests/Feature/WebhookTest.php
  测试目录中可能包括一些特征测试案例，以确保Webhook功能正常工作.

• resources/lang/en/messages.php
  可能存储翻译字符串，尤其是与验证相关的错误消息.

此外, 在全局范围内可能存在一个或多个其他地方涉及到Webhook处理的功能, 如控制器和路由.

启动文件介绍

boot.php (在服务提供商内部)

当包被注册到你的项目时(通常是在App\Providers\AppServiceProvider.php)，Spatie\WebhookServer\WebhookServerServiceProvider类中的boot方法将会被调用。

在这之中会发生的关键事件是：

• 注册发布器, 允许用户通过 php artisan vendor:publish --provider="Spatie\WebhookServer\WebhookServerServiceProvider" 命令访问和自定义该包的配置。
• 服务提供者还负责加载和绑定必要的服务进容器, 它们对于Webhook服务器的操作至关重要。

核心路由文件（routes/web.php 或 routes/api.php）

在核心路由文件内, 需要定义Webhook接收的路由. 示例：

use Spatie\WebhookServer\Laravel\Facades\Webhook;
//...

Route::post('/webhooks/{provider}', function ($provider){
     $webhook = Webhook::getForProvider($provider);
     
     // 处理接收到的数据...
});

配置文件介绍

当你运行php artisan vendor:publish --provider="Spatie\WebhookServer\WebhookServerServiceProvider"之后, 会在config目录下创建webhook-server.php配置文件。以下是一些重要的配置选项：

configs

此数组用于设置不同的Webhook接收器(receivers). 每个接收器都表示一种可以接收和处理特定来源Webhook数据的机制。例如：

'receivers' => [
     'paypal' => [
         'secret' => env('PAYPAL_SECRET', ''),
     ],

     'stripe' => [
         'secret' => env('STRIPE_WEBHOOK_SECRET', ''),
     ],
],

每个receiver项都有自己的名称标识符，并且能够携带额外的信息，如秘密密钥(secret)，这用于对来自相应供应商的请求进行安全性和完整性的检查。

laravel-webhook-serverSend webhooks from Laravel apps项目地址:https://gitcode.com/gh_mirrors/la/laravel-webhook-server