SuperAPI AI 工具集

api-frontend-integration

编程与开发

查看项目

更新于 10-16 09:30

技能介绍

用途:前后端联调时使用,覆盖从 MSW Mock 切换到真实 API、前后端字段名与类型对齐、错误码到前端提示的映射、Token/Cookie 传递验证、分页筛选排序参数对接、文件上传及 WebSocket/SSE 联调。

主要能力:提供类型共享方案(tRPC 端到端类型安全、OpenAPI 生成类型、Monorepo 共享 types 包),Mock 先行(前端用 MSW 开发,环境变量控制启用,后端就绪后逐条验证切换),错误码映射表(后端 error.code 映射为前端 toast 或字段级错误),以及逐端点联调清单(URL、HTTP 方法、请求与响应字段名及类型、分页、排序、筛选、错误码、Token、CORS、Content-Type、文件上传、空结果、大数据量等)。

使用方式:类型共享可选 tRPC(服务端定义 router 并导出 AppRouter 类型,客户端自动推导)、OpenAPI 生成(npx openapi-typescript api.yaml -o src/types/api.ts 或 npx orval --input api.yaml --output src/api/)、或 Monorepo 共享 types 包。Mock 切换通过环境变量控制 MSW 启动,后端就绪后关闭并逐条验证。错误处理建立 ERROR_MESSAGES 映射表,处理 API 返回 code 并支持字段级错误。配套模板为 templates/integration-checklist.md。文件与代码示例见技能页面。

适用场景:涉及订单管理、库存、用户资源等前后端接口联调的 web 项目;含分页、筛选、排序、文件上传、WebSocket/SSE 等接口。

限制与常见坑:字段名大小写不一致、类型不一致(string ID 与 number)、CORS 未配置、Token 位置不对(Cookie 与 Header)、错误码未映射、分页起始值不一致、时间格式不统一、空数组与 null 差异、大数字 JSON 精度丢失、文件上传 Content-Type 错误。资料未提供具体收费、价格、平台或效果承诺。