在线预览 OpenAPI/Swagger 接口文档预览与 Mock Server 一键启动 AI 提示词 (Prompts)

工具定位

这是一条“在线工具生成型 AI 提示词(Prompts)”:让 AI 直接生成一个可运行、可构建、可部署的在线工具,用来把 OpenAPI/Swagger(JSON/YAML)接口规范变成可交互的在线预览站点,并在同一套项目里一键启动 Mock Server,方便前端/测试联调。

适用场景

适合团队在需求频繁变更时做接口对齐:产品/后端提供最新的 OpenAPI 文档,前端在网页里即可搜索接口、查看请求/响应示例、校验缺失字段,并立即启动 Mock 服务(可按环境切换、可自定义延迟/错误率)。也适合做对外 SDK 前的文档验收与 API 规范检查(命名、分页、错误码、鉴权、content-type)。

交付物要求

AI 需要输出:完整项目代码与文件结构、可复制的安装/运行命令、Docker 部署说明、可选的 Vercel/Render 部署指南、至少一组自动化测试(或可执行的 QA checklist),并给出本地验证步骤与常见故障排查。

AI 提示词(Prompts)

你是资深全栈工程师 + API 规范专家。请生成一个“在线 OpenAPI/Swagger 接口文档预览 + Mock Server 一键启动”的可部署项目,要求如下: 【目标】 - 做一个 Web 在线工具:用户可以粘贴或上传 OpenAPI 3.x 文档(JSON/YAML),页面即时渲染接口文档(分组、搜索、标签筛选、参数/响应展示、示例),并能点击按钮启动/停止 Mock Server。 - Mock Server 能根据 spec 自动生成路由,支持:固定示例、随机数据、延迟、错误率、鉴权开关(Bearer token 校验),并在 UI 里实时显示已启动端口与请求日志。 【技术栈约束】 - 使用 Type 。 - 前端:Next.js(App Router)或等价的 React 框架;必须有清晰的组件结构。 - 后端:Node.js(Express/Fastify 任选其一)。Mock Server 必须是一个独立可运行的服务模块(可被主应用以 child_process 启动/停止,或以同进程方式挂载,但要解释取舍)。 - 解析 OpenAPI:支持 JSON + YAML(使用 yaml 库);必须做 schema 基础校验与友好报错。 - 文档渲染:可以用 swagger-ui-react / redoc / 自己渲染(任选一种),但必须支持搜索与路径/方法的快速定位。 【功能清单】 1) 输入方式: - 文本粘贴区 + 文件上传(.json/.yaml/.yml)。 - 最近使用:保存最近 5 份 spec 到浏览器 localStorage(只存文本,不上传到第三方)。 2) 规范检查: - 提供“快速检查”按钮:输出检查报告(缺少 servers、重复 operationId、未声明 securitySchemes、响应码缺 4xx/5xx 兜底、分页/排序参数缺失等),以表格展示。 3) Mock Server: - 启动时选择端口(默认 4010),若被占用给出提示并可自动递增。 - 支持 per-route 配置:延迟(ms)、错误率(%)、示例模式(example/随机)。 - 请求日志:显示 method/path/status/耗时,并可导出为 JSON。 4) 安全与限制: - 文件大小限制与解析超时。 - 不要实现任何图片生成/渲染图/海报/插画相关能力;不引导接入 Midjourney/SD。 【项目结构与输出格式】 - 先输出项目文件树(tree 形式),再逐文件给出完整代码。 - 必须包含:README(运行/构建/部署/环境变量)、Dockerfile、docker-compose.yml、.env.example。 - 提供 npm s:dev/build/start/test。 【测试与验收】 - 至少提供 3 个自动化测试: - OpenAPI JSON 解析通过; - YAML 解析通过; - Mock Server 在给定示例时能返回预期 JSON。 - 另外提供一份 QA checklist(可复制执行),覆盖:上传/粘贴、渲染、搜索、启动/停止、端口占用、错误提示、日志导出。 【运行命令】 - 给出从零开始的命令:node 版本要求、npm install、npm run dev、如何启动 Mock。 请确保代码可直接复制运行,不要省略关键文件内容。

使用说明

发布后你只需要把 OpenAPI 文档粘贴进页面,点击“渲染预览”;需要联调时点击“启动 Mock”,复制 URL 给前端即可。若遇到端口冲突,按页面提示自动切换端口;如果文档解析失败,检查报告会给出定位到行号/字段路径的错误信息。

扩展建议

可扩展但不强制:增加 spec 差异对比(上传两份 spec 生成变更清单)、生成 Postman Collection、生成前端 API Client(仅代码生成,不涉及任何出图)。这些都应保持“在线工具”属性:可运行、可部署、可测试。

用户评论 (0)

登录后参与讨论

立即登录 注册账号

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

操作成功