API 文档生成器

从 OpenAPI 或注释生成美观的 API 文档

从 OpenAPI/Swagger 或结构化注释生成 HTML、Markdown、PDF API 文档，包含参数、请求体、响应示例和错误码。

示例结果

2 个示例

从 OpenAPI 生成 Markdown 文档

把紧凑的 OpenAPI 文档转换成带参数、响应、Schema 和错误码的 Markdown 接口说明。

# Demo User API

Version: 1.2.0

## Endpoints

### GET /users/{id}

**Summary:** Get user by ID

查看输入参数

{ "sourceText": "{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"title\": \"Demo User API\",\n \"version\": \"1.2.0\",\n \"description\": \"User management endpoints\"\n },\n \"servers\": [\n {\n \"url\": \"https://api.example.com\"\n }\n ],\n \"paths\": {\n \"/users/{id}\": {\n \"get\": {\n \"summary\": \"Get user by ID\",\n \"tags\": [\n \"users\"\n ],\n \"parameters\": [\n {\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"description\": \"User identifier\",\n \"schema\": {\n \"type\": \"string\",\n \"example\": \"u_123\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"User payload\",\n \"content\": {\n \"application/json\": {\n \"example\": {\n \"id\": \"u_123\",\n \"name\": \"Ada\"\n }\n }\n }\n },\n \"404\": {\n \"description\": \"User not found\"\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}", "sourceFormat": "json", "outputFormat": "markdown", "documentTitle": "Demo User API", "theme": "slate", "includeExamples": true, "includeSchemas": true }

把结构化注释渲染为交互式 HTML

使用结构化注释标签生成 HTML 接口页面，并关闭示例与 Schema 区块。

POST/invoices

Create invoice

查看输入参数

{ "sourceText": "@title Billing API\n@version 0.9.0\n@description Lightweight annotated API example\n@route POST /invoices\n@summary Create invoice\n@tag billing\n@query customerId string - Customer identifier\n@bodyparam amount number optional - Requested invoice total\n@request {\"customerId\":\"cust_1\",\"amount\":129.5}\n@response 201 Created\n@error 422 Validation failed", "sourceFormat": "comments", "outputFormat": "html", "documentTitle": "Billing API", "theme": "paper", "includeExamples": false, "includeSchemas": false }

API 源内容 *

源格式

输出格式

文档标题

主题

包含示例

包含 Schema

关键信息

分类: 开发与 Web
输入类型: textarea, select, text, checkbox
输出类型: file
样本覆盖: 4
支持 API: Yes

概览

API 文档生成器是一款专为开发者设计的实用工具，能够将 OpenAPI/Swagger 规范（JSON 或 YAML 格式）以及结构化注释快速转换为美观、易读的 API 文档。支持导出为交互式 HTML、Markdown 或 PDF 格式，并允许自定义文档标题、主题风格以及是否包含请求示例和 Schema，帮助团队高效交付标准化的接口说明。

适用场景

•需要将后端的 OpenAPI JSON 或 YAML 文件转换为前端可读的 Markdown 接口文档时。
•希望通过简单的结构化注释快速生成轻量级的交互式 HTML API 页面时。
•需要为外部客户或合作伙伴提供标准化的 PDF 格式 API 接入指南时。

工作原理

•在文本框中粘贴 OpenAPI 规范（JSON/YAML）或带有结构化标签的注释内容。
•选择源格式，并指定所需的输出格式（HTML、Markdown 或 PDF）。
•配置文档标题、主题风格（深色或纸张），并勾选是否需要包含示例和 Schema。
•点击生成，工具将解析源文本并输出排版精美的 API 文档文件供下载。

使用场景

前后端分离开发中的接口契约交付与同步。

为开放平台或 SaaS 产品构建对外的开发者接入中心。

快速为遗留项目或小型微服务生成轻量级的接口说明文件。

用户案例

1. 从 OpenAPI 生成 Markdown 文档

后端开发工程师

背景原因: 团队使用 Swagger 导出了一个包含大量接口的 OpenAPI JSON 文件，但前端团队更习惯在内部 Wiki 中查看 Markdown 格式的文档。
解决问题: 需要将紧凑的 JSON 规范转换为带参数、响应、Schema 和错误码的易读 Markdown 文件。
如何使用: 将 OpenAPI JSON 粘贴到“API 源内容”中，选择输出格式为“Markdown”，并勾选“包含示例”和“包含 Schema”。
示例配置: 源格式: OpenAPI JSON, 输出格式: Markdown, 主题: 深色, 包含示例: 是
效果: 成功生成结构清晰的 Markdown 文档，直接复制到团队 Wiki 中即可展示完整的接口说明。

2. 把结构化注释渲染为交互式 HTML

独立开发者

背景原因: 正在开发一个轻量级的计费 API，没有使用复杂的 Swagger 框架，仅在代码中写了简单的注释。
解决问题: 希望用最少的配置快速生成一个美观的 API 网页分享给测试人员。
如何使用: 粘贴带有 @route、@query 等标签的注释文本，选择源格式为“注释标注”，输出格式为“交互式 HTML”，并选择“纸张”主题。
示例配置: 源格式: 注释标注, 输出格式: 交互式 HTML, 主题: 纸张, 包含示例: 否
效果: 生成了一个单页面的静态 HTML 文件，包含清晰的接口列表和参数说明，可直接在浏览器中打开查看。

用 Samples 测试

html, markdown, pdf

PDF示例

2026-02-01 到 2026-02-10 工具生成的PDF示例

matched family markdown,pdf,text

markdown, pdf

Markdown 幻灯片示例

用于测试 PDF 导出的 Remark/Marp 风格 Markdown 幻灯片

matched family markdown,pdf,text

markdown, pdf

OpenAI API 示例

全面的OpenAI API示例，包括GPT模型、DALL-E图像生成、Whisper音频处理和函数调用

title token api

text

WebGPU 图形API

用于浏览器中高性能3D图形和GPU计算的现代图形API

title token api

text

常见问题

支持哪些版本的 OpenAPI 规范？

工具支持解析标准的 OpenAPI 3.x 和 Swagger 2.0 规范的 JSON 或 YAML 文件。

什么是结构化注释格式？

这是一种轻量级的标记语法，允许你使用 @route、@summary、@query 等标签直接在纯文本中定义接口信息，无需编写复杂的 JSON。

生成的 HTML 文档是静态的吗？

是的，生成的是包含交互式折叠面板和内联样式的静态 HTML 文件，可直接部署到任何 Web 服务器或本地打开。

可以隐藏接口的请求示例吗？

可以，在配置中取消勾选“包含示例”和“包含 Schema”选项，即可生成更紧凑的文档。

导出的 PDF 文档支持自定义主题吗？

支持，你可以选择“深色 (slate)”或“纸张 (paper)”主题，导出的 PDF 会保留相应的主题配色和排版风格。

API 文档

请求端点

POST /zh/api/tools/api-doc-generator

请求参数

参数名	类型	必填	描述
sourceText	textarea	是	-
sourceFormat	select	否	-
outputFormat	select	否	-
documentTitle	text	否	-
theme	select	否	-
includeExamples	checkbox	否	-
includeSchemas	checkbox	否	-

响应格式

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}

文件: 文件

AI MCP 文档

将此工具添加到您的 MCP 服务器配置中：

{
  "mcpServers": {
    "elysiatools-api-doc-generator": {
      "name": "api-doc-generator",
      "description": "从 OpenAPI 或注释生成美观的 API 文档",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-doc-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

你可以串联多个工具，比如：`https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`，最多20个。

如果遇见问题，请联系我们：[email protected]