跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://waffo.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

waffo-integrate 是 Waffo 官方的 AI 集成 Skill,帮助开发者通过交互式向导自动完成 SDK 集成。支持 Claude Code、Cursor 等 AI 编码工具。

接入路线图

1

准备项目

确认项目代码已在 Claude Code 或 Cursor 中打开。
2

安装 Skill

运行 npx @waffo/waffo-integrate
3

触发 Waffo 集成

在 AI 助手中要求集成 Waffo 支付。
4

回答业务问题

选择需要的能力,例如支付、退款、订阅、Webhook、商户配置查询和支付方式查询。
5

审核并生成代码

AI 工具会先展示代码预览,确认后生成 SDK 初始化、服务层、Webhook 处理和测试文件。
6

运行验证

AI 工具会运行集成测试,覆盖支付、退款、订阅和 Webhook 流程。
7

提交测试报告

将生成的测试报告发送到 Waffo 技术对接群确认。

为什么使用 waffo-integrate

指标使用 Skill手动集成提升
集成通过率100%75%+25%
平均耗时128s192s-33%
Token 消耗58.8k66.3k-11%

安装

npx @waffo/waffo-integrate

集成流程

1

触发 Skill

在 AI 助手中输入触发词:集成 Waffo 支付integrate waffo接入waffowaffo sdkwaffo payment
2

语言检测

Skill 自动检测项目语言:package.json → Node.js,pom.xml / build.gradle → Java,go.mod → Go。
3

功能选择

交互式选择需要的功能(逐个询问):支付、退款、订阅、Webhook、商户配置查询、支付方式查询。智能推荐:选了支付会建议接退款,选了订阅会建议接 Webhook。
4

框架选择(仅 Webhook)

语言推荐框架其他选项
Node.jsExpressNestJS, Fastify
JavaSpring Boot
GoGinEcho, Fiber, Chi
5

代码预览 & 生成

Skill 先展示完整代码供审核,确认后自动生成:SDK 初始化、支付/退款/订阅服务、Webhook 处理、测试文件、.env.example
6

集成验证(可选)

运行 15 项验收测试,覆盖支付、退款、订阅全流程。通过 HTTP 端点测试 + Playwright 自动化收银台操作 + 数据库状态检查。
验证完成后,请将生成的测试报告发送到贵司和 Waffo 的技术对接群(企微或 Lark 群),用于确认集成结果。

内置 13 条 API 规则

Skill 内置的规则自动防止常见错误:
#规则防止的问题
1Request ID 最长 32 字符超过 Waffo 幂等键长度限制
2订阅用 currency 不是 orderCurrency字段名混淆
3订阅用 amount 不是 orderAmount字段名混淆
4各操作的必填字段检查缺少 payMethodTypegoodsInfo
5periodType 仅 DAILY/WEEKLY/MONTHLY无效枚举 YEARLYMONTH
6periodInterval 是 String 不是 Number类型错误
7订阅必传 payMethodTypeSDK 报错 A0003
8productName 仅 ONE_TIME_PAYMENT / SUBSCRIPTION无效产品类型
9响应使用 isSuccess() 检查遗漏错误处理
10Webhook 必须验签 + 响应签名安全漏洞
11Java 使用 WaffoConfig.builder()SDK 初始化失败
12时间戳 SDK 自动注入手动时间戳格式错误
13merchantId SDK 自动注入重复设置

生成的代码特性

  • 错误处理:区分 WaffoUnknownStatusError(可能成功)和 WaffoError(客户端错误)
  • 安全:Webhook 签名验证 + 响应签名、环境变量管理凭证
  • 最佳实践:幂等请求 ID、服务层分离、Webhook 先注册后解析 JSON
  • 测试:沙盒集成测试桩、测试卡号
详细文档参见 waffo-integrate GitHub