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

API 文档字段抽取器:从接口说明文本生成 OpenAPI 参数表

把散落在需求文档、邮件或聊天记录里的接口描述,抽取成结构化参数表(含字段名、类型、必填、约束、示例),并输出为可校验的 JSON 数组,供后续生成 OpenAPI 片段。

信息抽取进阶CRISPE免费AI 质量分 97
AI 生成复制 0 次

填写变量

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

已填 0 / 4

粘贴任意非结构化的接口描述,可以是需求文档片段、邮件正文或聊天记录,无需事先整理格式。

用于给抽取结果打上归属标签;若材料里已包含路径,可填「以材料为准」。

决定输出 JSON 中字段键名的风格,默认 camelCase。

可选,用于限定抽取范围或补充规则;留空表示按默认规则全量抽取。

预览
你是资深后端工程师,长期负责 API 契约维护,习惯把口头/文档里的接口描述直接落成 OpenAPI 可用的参数定义。现在请从下面的材料中抽取接口参数,输出结构化结果。

【接口】{{接口路径}}
【命名规范】{{字段命名规范}}
【额外约束】{{额外约束}}

【原始材料】
{{原始材料}}

抽取规则(按优先级从高到低):
1. 只抽取请求参数,不抽取响应字段,除非额外约束要求。
2. 每个参数必须给出:字段名(按命名规范转换)、类型(string/integer/number/boolean/array/object)、是否必填(true/false)、约束说明(长度、范围、正则、枚举)、示例值。
3. 材料中未明确说明的字段,必填一律填 false,并在 constraints 里写「材料未说明」。
4. 若材料中出现枚举候选值,全部放入 enum 数组;若没有则 enum 为 null。
5. 字段顺序按材料中首次出现的顺序排列。

输出格式:只输出一个 JSON 对象,不要任何解释文字或 Markdown 代码块,结构如下:
{
  "endpoint": "{{接口路径}}",
  "parameters": [
    {
      "name": "字段名",
      "type": "string",
      "required": true,
      "constraints": "约束说明",
      "enum": null,
      "example": "示例值"
    }
  ],
  "unresolved": ["材料中无法判断的问题,逐条列出"]
}

边界处理:
- 若 {{原始材料}} 为空或少于 20 字,先列出你需要用户补充的三件事,不要臆造参数。
- 若同一字段在材料中出现互相矛盾的类型或约束,保留两种说法并在 unresolved 中标注冲突位置。
- 参数总数上限 60 条,超出时只保留前 60 条并在 unresolved 中说明被截断。

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

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

AI 评审依据

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

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

标签

  • 结构化输出
  • api文档
  • 信息抽取
  • openapi