分类

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

关键信息

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

概览

API 文档生成器可以把 OpenAPI 规范或结构化代码注释整理成清晰、专业、便于分享的 API 文档。

适用场景

•当你希望从同一份 API 源信息导出 HTML、Markdown 和 PDF 文档时。
•当后端团队需要把请求、响应、参数和错误码统一整理出来时。
•当你已经有 Swagger 或 OpenAPI 内容，但展示效果不够友好时。
•当项目里只有注释而没有正式 API 文档页面时。

工作原理

•粘贴 OpenAPI JSON、YAML，或按约定写好的接口注释。
•工具会提取端点、参数、请求体、响应和错误码等信息。
•再把这些信息渲染成结构完整、视觉清晰的 API 文档。
•你可以按需要保留 Schema 和示例，方便技术读者直接查看。

使用场景

为内部平台或后端服务生成统一接口文档。

为第三方合作方准备对接说明页面。

输出 PDF 版本用于审计、交付或入职资料。

生成 Markdown 并直接提交到代码仓库中。

用户案例

1. 把支付接口规范整理成合作方文档

后端开发者

背景原因: 团队已经维护了一份支付服务的 OpenAPI 规范。
解决问题: 需要生成一份更适合外部合作方阅读的 API 文档。
如何使用: 粘贴 OpenAPI 内容，选择 HTML 或 PDF，并保留示例展示。
示例配置: 源格式：自动识别。输出格式：交互式 HTML 或 PDF。
效果: 团队可以快速得到包含端点、参数、Schema 和响应说明的专业文档。

用 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

WebGPU 图形API

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

title token api

text

OpenAI API 示例

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

title token api

text

常见问题

支持 Swagger 或 OpenAPI 文件吗？

支持。工具可处理 OpenAPI/Swagger 风格的 JSON 或 YAML 输入，并自动整理成接口文档结构。

能包含请求示例、响应示例和错误码吗？

可以。只要源数据中包含这些信息，生成结果就能把它们展示出来。

可以导出多种格式吗？

可以。同一份输入可以导出为交互式 HTML、Markdown 或 PDF。

如果还没有完整 OpenAPI 文件怎么办？

可以先使用结构化注释输入，适合接口规范尚未完全成型的阶段。

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]

分类