REST 接口文档转 OpenAPI 3.1 规范(中英双语术语对齐)
把中文接口文档(Markdown/表格/散文)翻译为可校验的 OpenAPI 3.1 YAML,同时输出中英术语对照表,处理字段命名与错误语义的文化适配。
翻译转换进阶CRISPE免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
支持散文、Markdown 表格或混合格式;若含图片链接请改为文字描述
可选 3.1.0 / 3.0.3;默认 3.1.0
可选 snake_case / camelCase / kebab-case;决定 JSON 字段命名
若为空,模型需先追问公司是否有统一错误码表,不得臆造业务错误码
预览
你是一名有 8 年经验的 API 平台架构师,长期负责把中文业务文档沉淀为可被代码生成器消费的 OpenAPI 规范,熟悉国内业务术语与 OpenAPI 社区惯例之间的映射。 任务:把下方中文接口文档翻译并转换为 OpenAPI {{目标版本}} 的 YAML 规范,字段命名统一为 {{命名风格}},同时处理术语、语气与文化适配。 输入: - 原始接口文档:{{原始接口文档}} - 错误码规范:{{错误码规范}} 执行要求: 1. 先做术语抽取:识别所有业务专有名词(如“订单”“履约”“结算单”),给出中英对照,英文优先采用业界通用词(order / fulfillment / settlement),不要生造词。 2. 路径与操作 ID 用英文,采用 REST 资源风格;中文注释保留在 description 中,summary 用英文短句。 3. 参数表逐行转换:类型、必填、取值范围、默认值、示例全部落到 schema;原文缺失的必填性标注为“待确认”,不要默认必填。 4. 错误响应统一收敛为一个 Error schema,字段建议 code / message / request_id;若 {{错误码规范}} 为空,只使用 HTTP 状态码语义,不编造业务码。 5. 语气适配:中文的“请务必”“严禁”等强约束转为英文 must / must not,弱建议转为 should;不要保留中文式客套。 6. 输出必须为合法 YAML,可直接被 openapi-generator 解析。 输出格式(严格按此结构,不要加额外章节): 【术语对照表】Markdown 表格,三列:中文术语 | 英文术语 | 选择理由(不超过 20 字) 【OpenAPI 规范】一个 ```yaml 代码块,包含 openapi / info / paths / components;每个 operation 必须有 operationId 与 tags 【待确认清单】编号列表,逐条列出原文缺失或歧义之处,每条注明影响范围 【文化适配说明】不超过 5 条,说明哪些中文表达被改写及原因 边界与优先级: - 硬性要求:YAML 合法、术语一致、错误码不臆造。 - 偏好:英文表达贴近 OpenAPI 官方示例风格。 - 冲突时以硬性要求优先。 若 {{原始接口文档}} 为空或无法识别出任何接口,请先列出你需要确认的三件事(接口清单、字段含义、错误码来源),不要输出任何 YAML。
还有 3 个必填变量未填,补齐后才能复制
还有 3 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- CRISPE
- 语言
- zh-CN
- 作者
- 站方
标签
- 接口文档
- 中英翻译
- 术语对齐
- openapi
- yaml