用途:在 Convex 应用中定义 HTTP 端点,用于接收第三方服务 Webhook、创建自定义 API 路由、处理文件上传下载、集成外部服务以及返回动态内容。
主要能力:通过 httpRouter 与 httpAction 注册路由,支持 GET、POST、OPTIONS 等方法;可解析 JSON、表单数据与原始字节;支持 pathPrefix 前缀匹配动态路径;可配置 CORS 头并处理预检请求;可在处理器内调用 ctx.runQuery、ctx.runMutation、ctx.runAction 访问数据库与内部逻辑;支持 API Key、Bearer Token 等鉴权方式;可结合 Node.js 动作验证 Stripe、Clerk 等 Webhook 签名;支持将文件存入 Convex storage 或重定向到文件 URL。
使用方式:在 convex/http.ts 中创建 httpRouter,用 http.route 注册路径与处理器,并默认导出;处理器接收 ctx 与 request,返回标准 Response。实现前建议查阅官方文档:https://docs.convex.dev/functions/http-actions、https://docs.convex.dev/functions/actions、https://docs.convex.dev/auth,以及 https://docs.convex.dev/llms.txt。
适用场景:Webhook 接收与签名校验、对外 API 路由、文件上传下载、第三方服务集成、需要鉴权的受保护端点。
限制:资料未提供具体收费、价格、平台支持范围与性能数据;示例中的密钥与签名验证依赖环境变量,需自行配置;部分能力需在 Node.js 动作中实现。