将 Swagger/OpenAPI 端点转换为高质量的 Markdown 文档
SwagDocs - Swagger/OpenAPI 到 Markdown 转换器
只需单击一下,即可将任何 Swagger UI 或 OpenAPI 文档转换为干净、可供开发人员使用的 Markdown。
SwagDocs 是开发人员、技术作家和 AI 工程工作流程的终极伴侣。它直接集成到 Swagger UI 页面中,允许您选择特定的 API 端点并立即生成高质量、LLM 友好的 Markdown 文档。
🚀 主要特点
通用兼容性:适用于托管标准 Swagger UI(Spring Boot、NestJS、.NET 等)的任何网站,包括嵌入式 iframe 或单页应用程序 (SPA) 中的网站。
一键选择:将本机复选框直接添加到 Swagger UI。轻松选择单个端点或整个组。
AI 优化输出:生成干净、结构化的 Markdown,格式完美适合大型语言模型(ChatGPT、Claude、Gemini)或您的技术文档。
自定义系统提示:使用您自己的系统提示自定义输出上下文(例如,“您是高级前端工程师...”)以获得与您的特定技术堆栈匹配的代码生成结果。
即时预览和下载:实时预览生成的 Markdown 或立即将其下载为 api-docs.md 文件。
可视化逻辑:方法(GET、POST、DELETE 等)和选定状态的可视化指示器可确保您准确了解正在记录的内容。
🛠️ 它是如何运作的
导航到任何 Swagger UI 页面。
使用注入的复选框选择您需要的端点。
打开 SwagDocs 弹出窗口以预览生成的 Markdown。
复制到剪贴板或下载为文件,以便与您的 AI 助手或文档代码库一起使用。
🆕 最新消息
下载功能:直接将文档另存为 .md 文件。
增强检测:现在可以在现代 SPA 和异步加载的 Swagger 文档上可靠地工作。
稳健的布局:改进的视觉集成,尊重主机站点的样式。
🌐官方资源
登陆页面:https://swagdocs.congphan.dev
源代码:https://github.com/cong85010/swagdocs



