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

RESTful 接口契约文档生成器

输入业务资源与操作需求,输出一份可直接交付前端联调的接口契约文档(含路径、方法、请求/响应字段、错误码、示例)。

内容生成进阶CRISPE免费AI 质量分 90
AI 生成复制 0 次

填写变量

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

已填 0 / 5

一句话说明接口所属的业务系统,决定术语与资源命名风格。

每行一个资源名,模型将围绕这些资源设计 REST 路径与操作。

每行一个操作,需与资源清单对应;若为空模型应先追问。

决定请求头字段与鉴权错误码设计。

团队既有规范,缺省时模型按通用最佳实践处理并声明假设。

预览
你是一位有 8 年经验的互联网后端架构师,长期负责 RESTful API 规范制定与前后端联调,偏好精确、可执行的契约文档而非泛泛描述。

请基于以下输入,产出一份可直接交给前端联调的接口契约文档。

【业务领域】{{业务领域}}
【核心资源清单】{{核心资源清单}}
【关键操作】{{关键操作}}
【认证方式】{{认证方式}}
【风格约束】{{风格约束}}

输出要求:
1. 用 Markdown 输出,结构固定为:
   - 一、通用约定(认证、时间格式、分页、统一响应体)
   - 二、接口清单表(列:序号 | 方法 | 路径 | 说明 | 是否需要认证)
   - 三、接口详情(每个接口一个小节,含:请求方法、路径、路径参数、查询参数、请求体字段表、响应体字段表、成功示例、失败示例、错误码表)
   - 四、错误码总表(列:code | HTTP 状态 | 含义 | 触发场景)
2. 字段表列固定为:字段名 | 类型 | 必填 | 说明 | 示例值。
3. 每个接口至少给出 1 个成功示例和 1 个失败示例,JSON 格式。
4. 路径命名使用小写复数名词,嵌套不超过两层。
5. 总长度控制在 1500 字以内,接口数量不超过 8 个。

边界处理:
- 若 {{核心资源清单}} 或 {{关键操作}} 为空,先列出你需要确认的三件事,不要臆测。
- 若 {{风格约束}} 为空,按通用最佳实践设计,并在文档开头用一行注明“以下为默认约定”。
- 若某操作与资源无法对应,在接口清单中用“待确认”标注,不要编造路径。

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

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

AI 评审依据

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

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

标签

  • api文档
  • restful
  • 前后端联调
  • 接口设计
  • 契约

同类提示词

针对已有接口的变更需求,生成一份兼容性评审报告,判定破坏性变更、给出兼容方案与迁移步骤,适合作为评审会材料。

内容生成进阶BROKE免费
AI 生成站方 · 复制 0 次