AgentSkillsCN

Fill Api Skill

填充 API 技能

SKILL.md

Fill API Skill

根据设计文档中的接口描述，自动完善代码中的 API 调用实现。

何时使用

  • •当用户需要根据设计文档完善 API 调用时
  • •当用户输入 "fill api"、"完善接口"、"补充 API" 等意图时
  • •当代码中有 TODO 标记的接口需要实现时

能力

此 Skill 可以：

  1. •分析设计文档中的接口描述
  2. •查找代码中 // TODO 标记的接口调用位置
  3. •在 src/request/api/ 目录下创建或更新对应的 API 模块
  4. •从 src/shared/ 导入类型定义
  5. •完善字段定义，与 API 字段名对齐
  6. •优化类型导入

参数

  • •设计文档路径：包含接口描述的设计文档 markdown 文件路径

项目 API 规范

请求模式

typescript
import { get, post } from '@/request/axios'
import type { GetUsersRequest, GetUsersResponse } from '@/shared/users'

export const getUserList = async (params?: GetUsersRequest) => {
  return get<GetUsersRequest, GetUsersResponse>('/api/users/list', { params })
}

响应处理模式

typescript
const [data, error] = await getUserList({ page: 1, pageSize: 10 })

if (error) {
  // 错误已通过拦截器显示
  return
}

// 使用 data.data
console.log(data.data.list)

实现步骤

  1. •

    分析设计文档

    • •读取设计文档，解析"可能用到的接口"部分
    • •识别文档中标注的文件位置和关键代码
    • •提取接口描述
  2. •

    代码分析与完善

    • •查找 TODO 接口标记
    • •完善 API 函数
    • •对齐字段定义
    • •优化类型导入
  3. •

    生成报告

    • •显示识别到的接口列表
    • •列出所有修改的文件路径
    • •提供后续建议