Copilot 自定义指令实战:接口调用层生成的 prompt.md 示例
「接口调用层生成」是前端工程师的高频任务。它的输入通常是接口文档,期望得到的是请求函数代码。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。
本文介绍如何在 GitHub Copilot 指令与提示文件 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 接口调用层生成(api-client-gen) |
| 作用 | 根据接口文档生成带类型的前端请求函数 |
| 输入 | 接口文档 |
| 输出 | 请求函数代码 |
| 形态 | 带脚本 |
| 风险 | 低 |
| 适用人群 | 前端工程师 |
处理流程分四步:
- 解析接口
- 生成类型定义
- 封装请求与错误处理
- 写使用示例
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;风险较低,但输出仍需快速过目再使用。
在 GitHub Copilot 指令与提示文件 中是什么形态
GitHub Copilot 支持仓库级自定义指令文件 .github/copilot-instructions.md,以及放在 .github/prompts/ 下、以 .prompt.md 结尾的可复用提示文件,适合把固定流程交给 Copilot Chat 或智能体模式执行。
仓库级指令对该仓库的对话默认生效;提示文件需要在支持的编辑器中手动调用,具体支持情况以 Copilot 文档为准。
示例配置
.github/prompts/api-client-gen.prompt.md 示例(示意):
---
description: 接口调用层生成
---
请对我提供的接口文档执行「接口调用层生成」:
1. 解析接口
2. 生成类型定义
3. 封装请求与错误处理
4. 写使用示例
输出格式:请求函数代码。
- 视觉与交互结果要在真实浏览器里确认。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在前端工程师提出相关请求时能对上号;二是约束部分要写进「视觉与交互结果要在真实浏览器里确认」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在
.github/copilot-instructions.md中写入团队通用约定 - 新建
.github/prompts/api-client-gen.prompt.md写入本技能流程 - 在编辑器的 Copilot Chat 中调用该提示文件
- 检查输出是否遵循步骤与格式
- 提交到仓库并在 PR 中说明用途
实操:一次完整的运行
假设你在浏览器、组件库与设计稿中发出这样的请求(虚构示例):
用接口调用层生成技能处理这份接口文档,输出请求函数代码。
智能体识别到任务与「接口调用层生成」相关后,会依次解析接口、生成类型定义、封装请求与错误处理、写使用示例。最终交付请求函数代码,并在末尾列出需要人工确认的内容。你的工作是对照原始接口文档抽查两三处关键信息,确认无误后再使用。
测试与验收
在 Copilot Chat 中分别以有、无提示文件的方式处理同一任务,对比差异是否符合预期。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准接口文档,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 仓库级指令写得过细,与提示文件互相矛盾。
- 以为提示文件会自动生效,实际需要手动调用。
- 只写了步骤,没写交付格式,导致每次输出的请求函数代码结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 接口调用层生成 · Gemini CLI 版
- 接口调用层生成 · OpenAI Agents SDK 版
- 接口调用层生成 · GPTs 版
- 界面微文案 · GitHub Copilot 指令与提示文件 版
- 页面性能优化 · GitHub Copilot 指令与提示文件 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。