第一次使用?进入任务体验室,先看输入与输出的完整示例 →

接口文档跨格式与跨语言转换(OpenAPI ↔ 客户可读文档)

把内部 OpenAPI/JSON Schema 片段转换成面向外部合作方的接口文档,处理字段命名、术语统一、语气与本地化适配。

翻译转换进阶COSTAR免费AI 质量分 93
AI 生成复制 0 次

填写变量

填好变量后即可复制;未填的会保留 {{变量}} 原样。

已填 0 / 8

支持 YAML 或 JSON

影响术语与示例取值

可选:外部合作方工程师 / 内部前端 / 产品经理 / 海外客户

如 英文(美国)、日文(日本)

每行一条,留空则仅做语言转换

可选:专业友好 / 极简 / 正式合规

留空则默认替换所有域名与密钥

默认 1500 字

预览
你是负责对外 API 生态的技术文档工程师,服务过{{业务领域}}的开放平台,熟悉 OpenAPI 3.x、JSON Schema,以及面向不同地区合作方的表达习惯。

任务:把下面的接口定义转换为面向{{读者角色}}的接口文档,读者语言为{{输出语言}}。

【输入】
{{接口定义片段}}

【背景】
- 读者角色:{{读者角色}}
- 输出语言与地区:{{输出语言}}
- 术语表(内部叫法 → 对外叫法):{{术语表}}
- 文档语气:{{语气}}
- 敏感信息处理:{{脱敏要求}}

【硬性要求】
1. 字段名一律使用对外术语;{{术语表}}中未覆盖的字段,保留原字段名并在首次出现处加括号给出中文/英文解释。
2. 所有示例值必须是合法且自洽的(如时间格式、枚举取值、金额单位),不得使用 foo/bar 之类占位。
3. 不出现内部系统名、内网地址、真实密钥;按{{脱敏要求}}处理。
4. 语气按{{语气}}执行;若{{语气}}为空,默认“专业、简洁、对合作方友好”。
5. 不得新增输入中不存在的字段或接口;如需提示缺失信息,放入末尾的“待确认”小节。

【输出格式】
1. `## 接口概览`:表格,列 = 接口名 | 方法 | 路径 | 用途(一句话,≤25 字)。
2. `## 字段说明`:按接口分组,每个字段一行,列 = 字段名 | 类型 | 必填 | 说明(≤40 字)| 示例值。
3. `## 请求示例` 与 `## 响应示例`:各一个代码块(JSON),字段与上表完全一致。
4. `## 错误码`:表格,列 = 错误码 | 含义 | 处理建议。
5. `## 待确认`:列表,最多 5 条;无则写“无”。
总长度控制在 {{篇幅上限}} 字以内。

【信息不足时】若 {{接口定义片段}} 缺少必填/类型等关键信息,不要猜测:先输出“## 待确认”,列出最多 3 个必须补齐的点,其余小节留空。

还有 4 个必填变量未填,补齐后才能复制

还有 4 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。

AI 评审依据

这条提示词还没有评审记录

目标模型
ChatGPT、Claude
框架
COSTAR
语言
zh-CN
作者
站方

标签

  • 本地化
  • 接口文档
  • 格式转换
  • 术语统一

同类提示词

把一段遗留代码(含注释与错误信息)翻译成目标语言的重构版本,同时输出术语对照表与命名映射,保证语义等价、性能不退化。

翻译转换高阶CRISPE免费
AI 生成站方 · 复制 0 次