onramplab/laravel-webhooks

Laravel Webhook 包简化了 Laravel 应用中的 webhook 发送过程。它允许用户轻松触发 webhook，自定义有效负载，设置排除标准，处理重试，并增强安全性。

维护者

详细信息

github.com/OnrampLab/laravel-webhooks

源代码

问题

安装: 700

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放性问题: 0

v1.1.0 2024-01-12 09:46 UTC

Requires

Requires (Dev)

MIT 9445a2cab8eb2bb5fff248780afffcfa745f810c

  • Onramp Lab <dev.woop@onramplab.com>

packagelaravelwebhooklaravle packagelaravel webhooksdispatch webhooks

This package is auto-updated.

Last update: 2024-09-12 11:24:40 UTC

README

Software License CircleCI Total Downloads

Laravel Webhook 包简化了 Laravel 应用中的 webhook 发送过程。它允许用户轻松触发 webhook，自定义有效负载，设置排除标准，处理重试，并增强安全性。

要求

  • PHP >= 8.0;
  • composer.

特性

该包的关键特性包括

  • Webhook 发送：无缝将 webhook 发送到外部服务或根据您的 Laravel 应用程序中的事件执行自定义操作。

  • 自定义有效负载：赋予用户定义自己的 webhook 有效负载的权力，允许他们包含相关数据并将其定制为接收服务的需求。

  • 排除标准：使用户能够设置排除标准，以选择性地阻止某些事件或条件触发 webhook。这为确定哪些事件应发送 webhook 提供了灵活性。

  • 重试机制：实现可配置的重试机制以处理 webhook 发送失败，确保即使在临时问题的情况下也能可靠地交付。

  • 安全选项：结合可选的身份验证机制，如标题或密钥，以保护 webhook 并确保它们只能由受信任的源触发。

  • 动态自定义字段

安装

composer require onramplab/laravel-webhooks

这将为您创建一个基本的项目结构

  • /build 默认用于存储代码覆盖率输出；
  • /src 是您的代码所在之处，每个类都需要位于此文件夹中的单独文件中；
  • /tests 在 src 文件夹中编写的每个类在“包含”到其他地方之前都需要进行测试。因此，我们基本上在该文件夹中有测试类来测试其他类；
  • .gitignore 有某些我们不希望发布到 Git 的文件，所以我们只需将它们添加到该文件即可，以便它们被“忽略”。
  • CHANGELOG.md 用于跟踪包更新；
  • CONTRIBUTION.md 贡献者公约代码行为准则；
  • LICENSE 其他程序员允许使用此库的自由条款；
  • README.md 是库的迷你文档，这是您的仓库的“主页”，如果您将其发布到 GitHub 和 Packagist 上；
  • composer.json 存储有关您的库的信息，如包名、作者和依赖项；
  • phpunit.xml 是 PHPUnit 的配置文件，以便测试类可以测试您编写的类；
  • .travis.yml Travis CI 的基本配置，并配置了代码气候的测试覆盖率报告。

有关更多信息，请参阅原始 文章。

有用工具

运行测试

php vendor/bin/phpunit

或

composer test

代码检查工具

php vendor/bin/phpcs --standard=PSR2 src/

或

composer psr2check

代码自动修复工具

composer psr2autofix
composer insights:fix
rector:fix

构建文档

php vendor/bin/phpdoc -d "src" -t "docs"

或

composer docs

变更日志

要跟踪，请参阅 CHANGELOG.md。

贡献

  1. 将其分支
  2. 创建您的功能分支（git checkout -b my-new-feature）。
  3. 进行更改。
  4. 运行测试，如果需要，添加新的测试（phpunit）。
  5. 提交更改（git commit -am '添加了一些功能'）。
  6. 推送到分支（git push origin my-new-feature）。
  7. 创建新的拉取请求。

同时请参考CONTRIBUTION.md。

许可协议

请参考LICENSE。