gemini api生成产品文档需结构化输入与强约束提示:①接口事实层(openapi 3.0 json)、②语义层(confluence链接或字段别名说明)、③约束层(明确markdown语法要求);采用嵌套锚点法或xml式指令法构建提示词,调用gemini-1.5-pro(temperature=0.2),输出后三步校验(标题数、代码块闭合、pandoc转html),通过则存入git并ci固化版本。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让Gemini API自动生成可直接交付的产品文档,但每次输出的Markdown结构混乱、标题层级错位、表格无法对齐、代码块丢失缩进——这导致你必须花30分钟以上手动修复格式才能发给产品和前端团队。
准备结构化输入数据
先确保Gemini能“看懂”你的接口事实。不要直接扔一段日志或模糊描述,而是整理出三类明确输入:
① 接口事实层:导出OpenAPI 3.0 JSON文件(路径、参数schema、响应status code必须完整);【缺失200/400/500状态码定义会导致错误码表为空】
② 语义层:提供一份Confluence链接或纯文本段落,说明该模块面向谁、核心业务目标、字段别名(如“user_id”在前端叫“用户唯一标识”);
③ 约束层:用一句话写清输出要求:“仅用标准Markdown语法,# 表示一级标题,## 表示二级标题,### 表示三级标题,代码块必须用```lang包裹,表格必须用|分隔且首行含分隔线。”
构造强约束提示词
方法一:嵌套锚点法(推荐用于首次生成)
在提示开头插入带标签的占位结构,例如:
# [产品名称] API 文档
## [接口功能简述]
### 请求地址
- HTTP 方法:
- URL:
### 请求参数
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| | | | |
结尾追加指令:“请严格复现上述结构,所有标题用#号标记,表格必须含分隔线,代码块必须用```包裹,不添加任何额外解释性文字。”
方法二:XML式指令法(适合已有初稿需重排版)
把Gemini已生成的混乱内容复制进来,加一句前缀:“请将以下内容转换为标准Markdown:所有‘第一章’改为‘# ’,所有‘1.’改为‘### ’,所有无序列表项前加‘- ’并顶格,所有代码片段用```python或```json包裹,所有表格补全|---|分隔行。”
调用Gemini 1.5 Pro并校验输出
使用新版 google-genai SDK 初始化模型:
from google import genai
model = genai.GenerativeModel("gemini-1.5-pro")
传入拼接好的提示词(事实层+语义层+约束层),设置temperature=0.2以降低随意发挥概率;
拿到response.text后,立即执行三步校验:
① grep -c "^#" 检查一级标题是否唯一;
② 检查是否存在未闭合的```(即```出现奇数次);
③ 用pandoc -f markdown -t html --standalone测试能否无报错转HTML——失败则说明Markdown语法有硬伤。
若校验失败,不要重试,直接提取错误位置所在段落,单独构造新提示:“修正以下表格:补全第二行分隔符,对齐第三列内容,删除多余空格。”
批量注入与版本固化
将校验通过的Markdown文档存入Git仓库,路径为docs/api/v1.2.0/product.md;
在CI流水线中配置GitHub Action:当OpenAPI JSON更新时,自动触发Gemini重生成→执行校验脚本→diff比对→仅当结构一致且新增字段被覆盖才允许合并;
每次发布新版本文档,同步更新文档页脚:“生成时间:2026-06-02|依据OpenAPI SHA:a7f3b9e”。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!










