在线预览 OpenAPI 静态文档站生成器 AI 提示词 (Prompts)

以下内容为“在线工具生成型 AI 提示词(Prompts)”合集,围绕 OpenAPI/Swagger 接口文档的离线预览、对比与交付场景。每条 Prompt 都要求 AI 输出可运行项目源码、文件结构、运行命令、部署说明与 QA 清单,并内置“一键输出 HTML”能力,方便直接交付与预览。

OpenAPI 文档解析与离线预览站

把 OpenAPI 3.0 JSON/YAML 解析为可离线打开的文档站,支持目录、搜索与示例展示。

提示词 (Prompts):

你是资深全栈工程师,请用中文输出一个可运行的前端项目源码,用于“OpenAPI 3.0 文档离线预览站”。 硬性要求: 1) 交付物必须包含完整文件树与每个文件的源码(至少包含 index.html、src/main.ts 或 main.js、样式文件、构建配置、README)。 2) 必须给出本地运行命令(开发/构建/预览)与静态部署说明(例如 Nginx/Netlify/GitHub Pages)。 3) 必须内置一个“示例 OpenAPI 文档”用于演示(放在 public/example.json 或内联)。 4) 工具功能:上传/粘贴 OpenAPI JSON 或 YAML;自动生成侧边栏目录(tags/paths);全文搜索;按路径展示请求方法、参数、请求体、响应、示例;高亮显示。 5) 新增硬约束:提供“一键输出 HTML”能力——页面提供按钮:将当前渲染后的文档站导出为单个可直接打开的 HTML 文件(包含必要的 CSS/JS 以内联方式打包),并自动下载。 6) 必须提供至少 8 条 QA checklist(含:YAML 解析、UTF-8、超大文件、移动端、搜索准确性、导出 HTML 可离线打开、错误提示、无网络资源依赖)。 7) 禁止引导生成任何图片/海报/渲染图;只做文档预览与导出。 技术栈约束:使用 Vite + Type  + 原生 DOM 或轻量框架(可选 Vue/React 其一,但不要同时用多个)。不依赖需要服务端的功能。 输出格式:先给出文件树,再逐文件给出完整源码,然后给出运行命令、部署说明、QA checklist。

主要用途: 适合把接口文档做成可离线交付的静态站,便于交接、审阅与存档。

Swagger UI 数据源改造与一键单文件导出

在不依赖外网 CDN 的前提下,提供接入 swagger-ui 的本地化方案,并支持一键导出单文件 HTML。

提示词 (Prompts):

请用中文生成一个可直接构建部署的前端项目:基于本地打包的 swagger-ui(或等价渲染器)实现“接口文档预览台”。 必须包含: - 完整文件树+源码(含 index.html、入口脚本、构建配置、静态资源拷贝策略) - 上传/选择 OpenAPI 文件(JSON/YAML)后渲染 - 主题切换(浅色/深色)与字体大小调节 - 错误边界:解析失败时给出可复制的错误详情 - 一键输出 HTML:把当前渲染页导出为单文件 HTML(把所需 JS/CSS 内联或打包进单文件),确保离线可打开 - 至少 6 个自动化测试或 QA checklist(覆盖导出后可用性、离线资源、不同浏览器) 运行命令:开发/构建/预览;部署:静态托管。 注意:不要引用任何外网 CDN;不得包含图片生成相关内容。

主要用途: 适合希望快速获得熟悉的 Swagger 交互体验,同时又要离线交付的团队。

OpenAPI 变更对比与差异报告预览

上传两份 OpenAPI 文档,生成差异视图与可交付的离线差异报告页面。

提示词 (Prompts):

请用中文输出一个可运行的“OpenAPI Diff 在线预览工具”完整项目源码。 功能需求: 1) 输入 A/B 两份 OpenAPI(支持粘贴/上传 JSON 或 YAML)。 2) 计算差异:新增/删除/修改的路径、方法、参数、请求体、响应;并按破坏性变更(breaking)标红。 3) 生成可筛选的差异列表(按 tag、路径、变更类型、breaking)。 4) 提供一键输出 HTML:把当前差异报告导出为单文件 HTML(离线打开仍可浏览与筛选)。 5) 交付物:文件树+源码、运行命令、部署说明、至少 10 条 QA checklist(含:大文档性能、差异准确性、breaking 判定、导出离线可用)。 技术栈:Vite + Type ,允许使用 diff 库但不要依赖服务端。禁止任何图片生成指令。

主要用途: 适合接口迭代评审、版本回归与发布前风险检查。

接口示例 Mock 数据生成与请求预览面板

根据 OpenAPI schema 生成可编辑的示例请求/响应,并提供可离线交付的预览页面。

提示词 (Prompts):

请用中文写一个前端项目,用于“OpenAPI 示例请求预览与编辑台”。 需求: - 导入 OpenAPI 文档后,按路径展示 endpoints - 自动从 schema 生成示例 JSON(支持基本类型、数组、对象、oneOf/anyOf 的合理默认) - 用户可在页面上编辑示例,并一键复制 - 提供一键输出 HTML:把当前选择的 endpoints 与示例内容导出为单文件 HTML(包含可折叠的面板、复制按钮) - 交付:文件树+源码、运行命令、部署说明、至少 8 条 QA checklist 限制:纯前端离线可用;不要调用真实接口;不要写任何图片生成相关内容。

主要用途: 适合交接联调时快速生成可读的示例与离线文档包。

OpenAPI 校验与可读性体检报告预览

对 OpenAPI 文档进行规则校验,输出可视化体检报告,并支持一键导出单文件 HTML。

提示词 (Prompts):

请用中文生成一个“OpenAPI 体检报告在线预览工具”的完整前端项目。 功能: 1) 导入 OpenAPI JSON/YAML 2) 做校验与体检:必填字段缺失、schema 引用循环、命名规范、tag 覆盖率、描述缺失率、示例缺失率 3) 输出报告:总分、问题列表、建议修复、按严重程度筛选 4) 一键输出 HTML:导出单文件 HTML 报告(离线可打开) 5) 交付:文件树+源码、运行命令、部署说明、至少 12 条 QA checklist 要求:报告页面必须可打印(print CSS);不依赖外网资源;禁止图片生成指令。

主要用途: 适合接口规范治理与文档质量审计。

多版本接口文档路由与离线合集站

把多个 OpenAPI 文档打包成一个离线合集站,支持版本切换与统一搜索。

提示词 (Prompts):

请用中文输出一个“OpenAPI 离线合集站”项目源码。 需求: - 支持导入多份 OpenAPI 文档,并为每份设置版本名(v1/v2/灰度等) - 左侧版本切换 + 当前版本的目录 - 支持跨版本搜索(路径/summary/描述) - 一键输出 HTML:导出单文件 HTML(包含所有版本数据与前端逻辑),离线打开可切换版本 - 交付:文件树+源码、运行命令、部署说明、至少 10 条 QA checklist 限制:纯前端;不引用外网 CDN;不写任何出图/渲染图相关内容。

主要用途: 适合对外交付多个版本接口文档,或内部存档。

接口字段字典与 Schema 浏览器

把 components/schemas 解析成字段字典与引用关系图谱列表(文本化),并可离线导出。

提示词 (Prompts):

请用中文写一个前端工具项目:解析 OpenAPI 的 components/schemas,生成“字段字典浏览器”。 功能: - schema 列表、搜索、查看字段路径(点号路径) - 显示引用链($ref 展开),并用文本方式展示依赖关系(禁止绘制生成图片) - 支持导出:一键输出 HTML(单文件)作为字段字典交付页 - 交付:文件树+源码、运行命令、部署说明、至少 8 条 QA checklist 要求:导出的单文件 HTML 内置数据;离线打开可搜索与展开。

主要用途: 适合前后端对齐字段含义、做数据对账与接口契约梳理。

接口变更公告生成器与预览页

从 OpenAPI Diff 结果生成变更公告(面向开发/测试/产品),并提供可离线交付的预览页。

提示词 (Prompts):

请用中文输出一个“接口变更公告生成与预览工具”的完整前端项目。 输入:A/B 两份 OpenAPI 文档。 输出: - 自动生成三种受众的公告视图:开发版(技术细节)、测试版(风险点/回归建议)、产品版(功能变化摘要) - 支持编辑公告内容、复制 Markdown 与复制纯文本 - 一键输出 HTML:把当前公告预览导出为单文件 HTML(离线打开可切换视图/复制) - 交付:文件树+源码、运行命令、部署说明、至少 10 条 QA checklist 限制:纯前端离线;不得包含任何图片生成或渲染图提示词。

主要用途: 适合发布前快速对齐信息,把差异转成可读公告并离线交付。

用户评论 (0)

登录后参与讨论

立即登录 注册账号

暂无评论,快来抢沙发吧~

操作成功