API 接口文档精排器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_f83a14de/api-doc-generator-plus。
技能介绍
要解决什么问题
团队里常见一份接口说明散落在 PDF、Word 表格、Markdown 或同事粘贴的纯文本里,格式不统一,也没有统一的 JSON 示例和导航。后端要对外交付时,往往还要再手工排版成可读文档,非技术同事改一个字就得回到 AI 重生成整份 HTML。
技能如何工作
本技能把非结构化 / 半结构化的接口描述解析后,输出左侧侧边栏 + 主内容区的单页 HTML:每个接口包含方法标签、URL、参数表、错误说明,以及格式化 + 语法高亮的请求/响应 JSON,并支持一键复制。
源材料优先级(越靠前识别越稳):OpenAPI/Swagger(json/yaml)→ Word 规范表格(.docx)→ 规范 Markdown 表格 → 纯文本/粘贴。本地文件可走 extract_api_content.py 统一抽取;OpenAPI 支持 $ref 有限深度展开。
内置编辑模式(必做)是 v2.2 起的硬约束:生成页必须带右下角编辑入口,非技术同事可在浏览器里改标题、参数表、JSON 示例、对接流程步骤与枚举行;参数表增删行会与对应 JSON 块联动(syncJsonFromTable / 参数名 blur 同步键名)。改动不自动保存,只有点「保存」才把 .main 的 HTML 写入 localStorage;「退出」会静默回滚未保存内容。可「导出最终版」HTML(去掉所有编辑控件)或走 window.print() + @media print 导出 PDF,零外部 PDF 库。
编辑模式 CSS/JS 需按 references/ 内联(Chrome 下操作按钮须用 div.action-btn,显隐用 opacity + pointer-events)。
适用边界
扫描版 PDF 无文本层需先 OCR;超大 PDF 建议拆分。Markdown 表格缺分隔行时参数表可能解析失败。JSON 示例须合法,否则与高亮/联动可能异常。腾讯文档(Canvas 渲染)不能直接用解析脚本抓链,需先按附录抓文字与 canvas 图再本地生成。
使用场景
- 拿到厂商 Word 表格版接口说明,要整理成带侧边栏导航和 JSON 示例的单页 HTML 给对接方
- 已有 OpenAPI/Swagger 的 yaml 或 json,要生成可读接口页并保留参数表与示例结构
- 对外文档初稿由 AI 生成后,产品或实施同事需在浏览器里改参数说明、对接流程步骤再导出最终版
- 会议里同事粘贴半结构化纯文本(参数名、类型、必填),要落成规范参数表并与请求 JSON 示例联动
适合人员
- 负责对外交付集成文档的后端,源材料混用 PDF、docx 与 OpenAPI,要统一成可分享的 HTML
- 写接口说明的技术文档同学,需要把 Markdown/Word 里的表格转成带复制与高亮的 JSON 展示页
- 对接实施或售前,要在不改代码的前提下微调枚举、流程步骤和 footer 后导出 PDF 给客户
- 维护多接口分组文档的架构师,希望从结构化 OpenAPI 展开 $ref 并生成侧边栏分组导航