Hono接口搭建
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/hono-api-scaffolder 到当前 AI 助手。
技能介绍
解决什么问题
当你的 Cloudflare Worker 基础外壳搭建完成后,随着业务增长,直接将所有接口逻辑堆砌在单个 index.ts 中会导致代码迅速膨胀且难以维护。硬编码路由、遗漏请求校验和鉴权逻辑,往往是引发线上故障的直接原因。本技能专注于在项目已有“外壳”的基础上,注入一套结构化的 API 脚手架,确保路由、中间件与文档具备一致性。
核心能力与工作流
本技能模拟一名脚手架工程师,将资源划分为多个独立文件,利用 Hono 实例化应用并挂载到主入口。
- 路由生成与校验:为每个资源组创建独立的路由文件。针对写操作(如
POST),集成zValidator与Zod进行 JSON 校验;资源未命中时返回标准的404,创建成功则返回201。 - 中间件管理:通过
createMiddleware实现Bearer token鉴权,利用cors()处理跨域请求,确保接口安全性。 - 类型与挂载:在
src/types.ts中定义Env接口(包含D1Database、KV 等绑定),并在主入口统一注册onError与/api/health健康检查。 - 文档产出:自动生成
API_ENDPOINTS.md,详细记录每个端点的参数形状与错误码。
适用边界
本技能的核心价值在于“生成代码骨架”。它不能替代业务逻辑实现,开发者仍需根据实际需求完善具体的字段校验规则与数据库查询逻辑。此外,它必须运行在已完成基础初始化的 Worker 项目之上。
使用场景
- 后端开发者在Worker外壳就绪后,需添加用户与文章两组接口,并配置跨域与鉴权中间件。
- 当路由逻辑混乱时,需将接口拆分为独立文件,并自动生成含参数与错误码的接口文档。
- 完善架构时,需定义包含数据库与KV的Env类型绑定,并在主入口注册错误处理与健康检查。
适合人员
- Cloudflare Workers后端工程师,需要在已有项目中快速构建规范的API路由与中间件结构。
- 独立全栈开发者,希望用AI自动生成包含Zod校验和接口文档的前后端调用契约。
- 中小型团队的技术负责人,负责审查Worker代码,确保路由文件、类型绑定与接口文档符合规范。