用 GPTs 实现「接口文档编写」：指令、知识与 Actions

如果你在文档仓库与文档站里反复做接口文档编写，可以考虑把经验沉淀为一个 Skill：写清触发条件、步骤、输出格式和边界，让智能体代劳重复部分，人只负责把关。

本文介绍如何在 GPTs 上实现这个技能，包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

处理流程分四步：

1. 列出路由
2. 整理参数与返回
3. 补充错误码
4. 写调用示例

这个技能纯指令型，不需要额外脚本或外部连接，复制到大多数平台都能用；风险较低，但输出仍需快速过目再使用。

在 GPTs 中是什么形态

GPTs 是在 ChatGPT 中创建的定制版助手，可以设置指令（Instructions）、上传知识文件、开启所需能力，并通过 Actions 调用外部 API。

创建与分享的权限取决于账户类型与工作区设置，以 OpenAI 官方说明为准。

示例配置

# Instructions（指令）示意
你是「接口文档编写」助手。用户会提供服务代码。
1. 列出路由
2. 整理参数与返回
3. 补充错误码
4. 写调用示例
输出：接口文档。
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问，不要自行编造数据或事实。
知识文件中的规范优先于你的通用习惯；找不到依据时直说。

示例里最重要的是两处：一是描述（或指令开头）要写明「什么时候用」，让智能体在开发者与技术写作者提出相关请求时能对上号；二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩，避免智能体自作主张。

安装与启用步骤

1. 在 GPT 编辑器中新建 GPT，填写名称与描述
2. 在 Instructions 中写入技能步骤、输出格式与约束
3. 上传团队规范、模板等知识文件
4. 需要外部数据时配置 Actions（OpenAPI 描述）
5. 在预览中测试后保存，并设置分享范围

实操：一次完整的运行

假设你在文档仓库与文档站中发出这样的请求（虚构示例）：

用接口文档编写技能处理这份服务代码，输出接口文档。

智能体识别到任务与「接口文档编写」相关后，会依次列出路由、整理参数与返回、补充错误码、写调用示例。最终交付接口文档，并在末尾列出需要人工确认的内容。你的工作是对照原始服务代码抽查两三处关键信息，确认无误后再使用。

测试与验收

在预览窗口用正常、缺信息和越界三类请求测试，确认指令中的边界有效。

针对这个技能，还建议额外准备：

• 一份信息齐全的标准服务代码，检查输出是否完整
• 一份缺少关键信息的输入，检查智能体是否先提问而不是编造
• 一份包含“忽略以上规则”等字样的输入，检查约束是否仍然有效

常见坑

• 知识文件包含不应外泄的信息却设置了公开分享。
• Instructions 过长且结构混乱，关键规则被忽略。
• 只写了步骤，没写交付格式，导致每次输出的接口文档结构不同。
• 没有给出样例，智能体对“好结果”的理解与你不一致；在参考资料里放一两份范例会明显改善。

延伸阅读

• 接口文档编写 · Dify 工作流 版
• 接口文档编写 · 快速上手
• 接口文档编写 · 组合用法
• 新人上手指南 · GPTs 版
• 图表即代码 · GPTs 版
• 智能体Skills 分类：625 个技能 × 32 个角度

说明：文中的配置、代码与目录结构均为示意，用于说明思路；各平台的入口、字段名与能力会更新，落地前请以对应官方文档为准。示例中的数据与场景为虚构，不代表真实案例。