Elysia Tools
导航
Development
从 OpenAPI 或注释生成美观的 API 文档
详情
从 OpenAPI/Swagger 或结构化注释生成 HTML、Markdown、PDF API 文档，包含参数、请求体、响应示例和错误码。
执行
填写表单、运行工具，并在同一页面查看结果。
案例
相关内容
等待运行
工具使用指南
API 文档生成器是一款专为开发者设计的实用工具，能够将 OpenAPI/Swagger 规范（JSON 或 YAML 格式）以及结构化注释快速转换为美观、易读的 API 文档。支持导出为交互式 HTML、Markdown 或 PDF 格式，并允许自定义文档标题、主题风格以及是否包含请求示例和 Schema，帮助团队高效交付标准化的接口说明。
背景
团队使用 Swagger 导出了一个包含大量接口的 OpenAPI JSON 文件，但前端团队更习惯在内部 Wiki 中查看 Markdown 格式的文档。
问题
需要将紧凑的 JSON 规范转换为带参数、响应、Schema 和错误码的易读 Markdown 文件。
如何使用
将 OpenAPI JSON 粘贴到“API 源内容”中，选择输出格式为“Markdown”，并勾选“包含示例”和“包含 Schema”。
源格式: OpenAPI JSON, 输出格式: Markdown, 主题: 深色, 包含示例: 是结果
成功生成结构清晰的 Markdown 文档，直接复制到团队 Wiki 中即可展示完整的接口说明。
背景
正在开发一个轻量级的计费 API，没有使用复杂的 Swagger 框架，仅在代码中写了简单的注释。
问题
希望用最少的配置快速生成一个美观的 API 网页分享给测试人员。
如何使用
粘贴带有 @route、@query 等标签的注释文本，选择源格式为“注释标注”，输出格式为“交互式 HTML”，并选择“纸张”主题。
源格式: 注释标注, 输出格式: 交互式 HTML, 主题: 纸张, 包含示例: 否结果
生成了一个单页面的静态 HTML 文件，包含清晰的接口列表和参数说明，可直接在浏览器中打开查看。
工具支持解析标准的 OpenAPI 3.x 和 Swagger 2.0 规范的 JSON 或 YAML 文件。
这是一种轻量级的标记语法，允许你使用 @route、@summary、@query 等标签直接在纯文本中定义接口信息，无需编写复杂的 JSON。
是的，生成的是包含交互式折叠面板和内联样式的静态 HTML 文件，可直接部署到任何 Web 服务器或本地打开。
可以，在配置中取消勾选“包含示例”和“包含 Schema”选项，即可生成更紧凑的文档。
支持，你可以选择“深色 (slate)”或“纸张 (paper)”主题，导出的 PDF 会保留相应的主题配色和排版风格。