webhook 是一种很常见的网络调用方式，可以用于实现各种自动化任务。webhook-catcher 是一个 npm 包，可以方便地在本地调试 webhook，同时也可以用于生产环境中的 webhook 捕获和分析。
本文将介绍如何使用 webhook-catcher，并且通过示例代码演示如何将 webhook-catcher 集成到一个 Node.js 应用中。
webhook-catcher 简介
webhook-catcher 可以解析、捕获和存储 webhook 请求，并提供一个简单的 Web UI 进行查看和导出。它支持通过 URL 参数、POST/PUT/PATCH 请求体、请求头以及签名鉴权方式来验证 webhook 请求的合法性。
webhook-catcher 可以作为一个 standalone 的应用运行，也可以集成到其他应用中。当前最新版本为 1.4.0，支持 Node.js 10.x 及以上版本。
安装和启动
要使用 webhook-catcher，首先需要在项目中安装它：
npm install -g webhook-catcher
然后，可以使用命令行启动 webhook-catcher：
webhook-catcher start
这样就可以在本地的 4000 端口上启动一个 webhook-catcher 服务。访问 http://localhost:4000，可以看到 webhook-catcher 的 Web UI。在这里可以查看已经捕获到的 webhook 请求，或手动发送一些 webhook 请求进行测试。
配置 webhook-catcher
webhook-catcher 提供了一些配置选项，可以在启动时通过命令行参数或环境变量进行设置。常用的配置选项包括：
-p, --port: 指定 webhook-catcher 监听的端口号，默认为 4000。-x, --proxy: 指定 webhook-catcher 后面的代理服务器地址，以便转发 webhook 请求。-d, --db-path: 指定 webhook-catcher 使用的 SQLite 数据库文件路径，默认为当前工作目录的webhook.sqlite。-c, --config: 指定 webhook-catcher 配置文件的路径，支持 JSON 或 YAML 格式。
可以使用 webhook-catcher --help 命令查看所有配置选项的说明。
使用 webhook-catcher
为了使用 webhook-catcher，需要在触发 webhook 的服务或应用中对 webhook 进行配置。以 GitHub 的 webhook 为例，可以按照以下步骤进行配置：
- 登录 GitHub 后访问要配置 webhook 的仓库的
Settings > Webhooks页面，点击Add webhook按钮。 - 在
Payload URL输入框中输入 webhook-catcher 的 API 地址，例如http://localhost:4000/webhook。 - 在
Content type下拉框中选择application/json或application/x-www-form-urlencode，视情况而定。 - 在
Secret输入框中输入 webhook-catcher 的签名密钥，用于验证 webhook 请求的合法性。 - 在
Events处选择需要监听的事件类型。 - 点击
Add webhook按钮保存配置即可。
这样，当触发了相应的事件后，GitHub 就会向 webhook-catcher 发送请求，并且 webhook-catcher 会捕获和存储这些请求。
集成 webhook-catcher 到 Node.js 应用
webhook-catcher 可以作为一个 standalone 的应用运行，也可以集成到其他应用中。下面将演示如何将 webhook-catcher 集成到一个 Node.js 应用中，使用 Express 框架示例。
首先需要安装 webhook-catcher 和 express：
npm install webhook-catcher express
在 Express 应用中引入 webhook-catcher 并启动它：
-- -------------------- ---- ------- ----- - -------------- - - --------------------------- ----- ------- - ------------------- ----- --- - ---------- ----- ---- - ----- -- -- ---------------------- ----- ------- - --- ----------------- -- - --------------- --- --------- --- -------------------- ---------------------- -- ---- ---------------- -- -- - ---------------- --------- -- -------------------------- ---
这样，就可以通过发送 POST 请求到 http://localhost:3000/webhooks 来触发 webhook，并且 webhook-catcher 会捕获和存储这些请求。
结论
本文介绍了如何使用 webhook-catcher 进行 webhook 的捕获和处理，并通过示例代码演示了如何将 webhook-catcher 集成到一个 Node.js 应用中。
总的来说，webhook-catcher 的功能较为简单，但使用方便，特别是在本地调试 webhook 时非常方便。在生产环境中，webhook-catcher 可以被用于在应用接收 webhook 前进行签名验证等操作，并提供可视化界面进行查看和分析。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005728581e8991b448e8bbb