Nuxt Webhook 验证器
一个简单的 Nuxt 模块，可在边缘运行，轻松验证来自不同服务的传入 Webhook。
功能
- 20 个 Webhook 验证器
- 在边缘运行
- 公开的 服务器工具
要求
此模块仅适用于运行 Nuxt 服务器时使用服务器 API 路由 (nuxt build)。
这意味着您不能将此模块与 nuxt generate 一起使用。
快速设置
- 在您的 Nuxt 项目中添加 nuxt-webhook-validators
npx nuxi@latest module add webhook-validators
- 在您的
nuxt.config.ts中添加模块
export default defineNuxtConfig({
modules: [
'nuxt-webhook-validators'
],
})
服务器工具
验证器辅助函数会在您的 server/ 目录中自动导入。
Webhook 验证器
所有验证器辅助函数都全局公开，可用于您的服务器 API 路由。
这些辅助函数返回一个布尔值，指示 Webhook 请求是否有效。
配置可以直接在您的 nuxt.config.ts 中的 runtimeConfig 中定义
export default defineNuxtConfig({
runtimeConfig: {
webhook: {
<provider>: {
<requiredProps>: '',
}
}
}
})
也可以使用环境变量设置
NUXT_WEBHOOK_<PROVIDER>_<REQUIRED_PROPERTY> = ""
前往 playground/.env.example 或 playground/nuxt.config.ts 查看每个提供者所需的所有可用属性列表。
支持的 Webhook 验证器
- Brevo
- Discord
- Dropbox
- Fourthwall
- GitHub
- GitLab
- Heroku
- Hygraph
- Kick
- MailChannels
- Meta
- NuxtHub
- Paddle
- PayPal
- Polar
- Resend
- Shopify
- Stripe
- Svix
- Twitch
您可以通过在 src/runtime/server/lib/validators/ 中创建一个新文件来添加您喜欢的 Webhook 验证器
示例
在服务器 API 路由中验证 GitHub Webhook。
~/server/api/webhooks/github.post.ts
export default defineEventHandler(async (event) => {
const isValidWebhook = await isValidGitHubWebhook(event)
if (!isValidWebhook) {
throw createError({ statusCode: 401, message: 'Unauthorized: webhook is not valid' })
}
// Some logic...
return { isValidWebhook }
})
开发
# Install dependencies
npm install
# Generate type stubs
npm run dev:prepare
# Develop with the playground
npm run dev
# Build the playground
npm run dev:build
# Run ESLint
npm run lint
# Run Vitest
npm run test
npm run test:watch
# Run typecheck
npm run test:types
# Release new version
npm run release