“这个接口的入参是什么结构”“返回值里 list 的每个 item 有哪些字段”“这个接口是 GET 还是 POST”每次写新页面都要翻接口文档找到对应接口看参数结构然后手写 TypeScript 类型定义。200 个接口每个都要重复这个过程。后来我做了一件事把接口信息喂给 AI让它永远记住。3 种做法选适合你的️ 整体方案流程图为了让您更清晰地了解如何选择适合自己的方案以下是三种方法的决策和执行流程图有没有愿意不愿意开始: 需要让AI记住接口信息后端是否有Swagger/OpenAPI?方式一: 引用Swagger文档导出JSON到项目在AI配置中引用文件路径是否愿意手动维护接口清单?方式二: 维护精简接口清单创建Markdown清单按业务域分组在AI配置中引用方式三: 从现有代码提取让AI扫描services目录自动提取接口信息配置完成AI生成Service层代码无需再查文档方式一引用 Swagger 文档最省事如果后端有 Swagger/OpenAPI导出 JSON 放到项目里然后在 AI 配置中引用# API 规范 接口定义见 #[[file:docs/api-spec.json]] ## 调用规范 - 接口函数放 src/services/domain/ - 命名动词 资源名getActivityList, createCoupon - 必须定义 Request/Response interface - 统一使用 src/api/axios.ts 的实例方式二维护精简接口清单最实用没有 Swagger手动维护一份也行# 接口清单 ## 营销域 - POST /api/activity/list — 活动列表分页 - POST /api/activity/create — 创建活动 - POST /api/activity/update — 编辑活动 - GET /api/activity/detail?id{id} — 活动详情 - POST /api/activity/updateStatus — 上下架 ## 会员域 - POST /api/member/list — 会员列表 - GET /api/member/detail?id{id} — 会员详情 - POST /api/member/update — 编辑会员 - POST /api/member/export — 导出方式三让 AI 从现有代码提取最快扫描 src/services/ 目录下所有文件 提取所有接口调用整理成接口清单 - [HTTP方法] [路径] — [功能描述] 按业务域分组。配置好之后的效果之前我帮我写活动列表页的 service 层 AI接口地址是什么请求方式是什么参数结构是什么 我翻文档复制粘贴一大段之后我帮我写活动列表页的 service 层用到 list 和 updateStatus 两个接口 AI直接生成完整的 service 文件类型定义正确可直接抄走的 Service 模板AI 生成 service 文件时遵循这个结构// src/services/marketing/activity.tsimportrequestfrom/api/axios// 类型定义 /** 活动列表请求参数 */interfaceGetActivityListParams{pageNum:numberpageSize:numberactivityName?:stringstatus?:number}/** 活动列表响应 */interfaceGetActivityListResult{list:ActivityItem[]total:number}/** 活动项 */interfaceActivityItem{id:numberactivityName:stringactivityType:numberstatus:numberstartTime:stringendTime:string}// 接口函数 /** 获取活动列表 */exportconstgetActivityList(params:GetActivityListParams)request.postGetActivityListResult(/api/activity/list,params)/** 更新活动状态 */exportconstupdateActivityStatus(data:{id:number;status:number})request.post(/api/activity/updateStatus,data)接口变更时怎么同步# 方案一定期从 Swagger 拉取加到 package.json scriptsscripts:{api:sync:curl -o docs/api-spec.json https://your-backend/v3/api-docs}# 方案二后端改接口时手动更新清单1 分钟的事一句话总结让 AI 记住你的接口信息每次写 service 层就不用再翻文档了。5 分钟配置省下几百次查文档的时间。 你们团队的接口文档是怎么管理的前端写类型定义是手动写还是有自动化方案
AI 死活记不住你的接口？我花 5 分钟配了个东西，从此一劳永逸
发布时间：2026/6/10 4:06:24
“这个接口的入参是什么结构”“返回值里 list 的每个 item 有哪些字段”“这个接口是 GET 还是 POST”每次写新页面都要翻接口文档找到对应接口看参数结构然后手写 TypeScript 类型定义。200 个接口每个都要重复这个过程。后来我做了一件事把接口信息喂给 AI让它永远记住。3 种做法选适合你的️ 整体方案流程图为了让您更清晰地了解如何选择适合自己的方案以下是三种方法的决策和执行流程图有没有愿意不愿意开始: 需要让AI记住接口信息后端是否有Swagger/OpenAPI?方式一: 引用Swagger文档导出JSON到项目在AI配置中引用文件路径是否愿意手动维护接口清单?方式二: 维护精简接口清单创建Markdown清单按业务域分组在AI配置中引用方式三: 从现有代码提取让AI扫描services目录自动提取接口信息配置完成AI生成Service层代码无需再查文档方式一引用 Swagger 文档最省事如果后端有 Swagger/OpenAPI导出 JSON 放到项目里然后在 AI 配置中引用# API 规范 接口定义见 #[[file:docs/api-spec.json]] ## 调用规范 - 接口函数放 src/services/domain/ - 命名动词 资源名getActivityList, createCoupon - 必须定义 Request/Response interface - 统一使用 src/api/axios.ts 的实例方式二维护精简接口清单最实用没有 Swagger手动维护一份也行# 接口清单 ## 营销域 - POST /api/activity/list — 活动列表分页 - POST /api/activity/create — 创建活动 - POST /api/activity/update — 编辑活动 - GET /api/activity/detail?id{id} — 活动详情 - POST /api/activity/updateStatus — 上下架 ## 会员域 - POST /api/member/list — 会员列表 - GET /api/member/detail?id{id} — 会员详情 - POST /api/member/update — 编辑会员 - POST /api/member/export — 导出方式三让 AI 从现有代码提取最快扫描 src/services/ 目录下所有文件 提取所有接口调用整理成接口清单 - [HTTP方法] [路径] — [功能描述] 按业务域分组。配置好之后的效果之前我帮我写活动列表页的 service 层 AI接口地址是什么请求方式是什么参数结构是什么 我翻文档复制粘贴一大段之后我帮我写活动列表页的 service 层用到 list 和 updateStatus 两个接口 AI直接生成完整的 service 文件类型定义正确可直接抄走的 Service 模板AI 生成 service 文件时遵循这个结构// src/services/marketing/activity.tsimportrequestfrom/api/axios// 类型定义 /** 活动列表请求参数 */interfaceGetActivityListParams{pageNum:numberpageSize:numberactivityName?:stringstatus?:number}/** 活动列表响应 */interfaceGetActivityListResult{list:ActivityItem[]total:number}/** 活动项 */interfaceActivityItem{id:numberactivityName:stringactivityType:numberstatus:numberstartTime:stringendTime:string}// 接口函数 /** 获取活动列表 */exportconstgetActivityList(params:GetActivityListParams)request.postGetActivityListResult(/api/activity/list,params)/** 更新活动状态 */exportconstupdateActivityStatus(data:{id:number;status:number})request.post(/api/activity/updateStatus,data)接口变更时怎么同步# 方案一定期从 Swagger 拉取加到 package.json scriptsscripts:{api:sync:curl -o docs/api-spec.json https://your-backend/v3/api-docs}# 方案二后端改接口时手动更新清单1 分钟的事一句话总结让 AI 记住你的接口信息每次写 service 层就不用再翻文档了。5 分钟配置省下几百次查文档的时间。 你们团队的接口文档是怎么管理的前端写类型定义是手动写还是有自动化方案
