SuperAPI AI 工具集

backend-endpoint

编程与开发

查看项目

更新于 10-25 16:17

技能介绍

用途

backend-endpoint 是一个后端 API 端点生成技能,旨在帮助开发者快速创建符合生产标准的 REST 或 GraphQL 端点。它适用于需要添加新 API 路由、创建 CRUD 接口或为现有资源生成标准化端点的场景。技能会自动识别用户意图(如“add endpoint”“create API”“new route”)并触发执行。

主要能力

  • 框架支持:Express(默认)、Fastify、NestJS、Next.js(App Router Route Handler)、GraphQL。
  • 路由生成:根据 HTTP 方法和资源名称生成路由处理器,支持路径参数。
  • 请求验证:支持 Zod(默认)、Joi、Yup、Express-validator,可生成验证模式文件。
  • 错误处理:内联编写错误处理中间件,包含状态码映射、响应格式化、日志集成等。
  • 测试生成:基于 supertest 生成集成测试,覆盖成功、验证错误、未找到、未授权、服务器错误等场景。
  • 文档注释:生成 JSDoc 或 OpenAPI 注释。
  • 知识图谱集成:在执行前查询项目知识图谱,应用已有模式、避免已知陷阱、遵守决策记录。

使用方式

  1. 触发:用户说出“add endpoint”“create API”“new route”等指令。
  2. 需求收集:技能询问端点路径、HTTP 方法、资源名称、框架、是否需要认证和验证。
  3. 模式检查:查询 .agent/knowledge/graph.json 获取项目内 API 相关模式、陷阱和决策。
  4. 验证理解:对于高风险操作,展示理解摘要并请求确认。
  5. 生成代码:使用 endpoint_generator.py 生成路由处理器,validation_generator.py 生成验证模式,内联编写错误处理和测试。
  6. 输出摘要:展示生成的文件结构、路由注册示例和测试命令,并可选输出执行摘要 JSON 用于图谱摄入。

适用场景

  • 快速搭建新项目的 API 骨架。
  • 为现有项目添加符合规范的端点。
  • 需要同时生成验证、错误处理和测试的完整端点。
  • 希望复用项目已有模式并避免重复已知问题。

限制

  • 技能依赖 Python 脚本和模板文件,需在特定环境(如 Claude 插件目录)下运行。
  • 错误处理和测试生成没有专用脚本,需模型内联编写。
  • 支持的语言主要为 TypeScript/JavaScript 生态,其他语言暂未提供。
  • 技能文档中未提及收费、价格或平台限制,相关信息暂未提供。