API 文档

返回首页

概述

我们的API允许您将Markdown文本转换为思维导图HTML文件。您可以使用此API将思维导图功能集成到您自己的应用程序中。 API会将生成的HTML文件保存在服务器上,并返回可访问的URL链接。

认证

所有API请求都需要使用API密钥进行认证。您需要在请求头中包含x-api-key字段。

请保管好您的API密钥,不要在公共场所分享或暴露它。

端点

转换Markdown为思维导图HTML

URL: /api/markdown-to-mindmap

方法: POST

内容类型: application/json

响应类型: application/json

请求参数

参数类型必填描述
markdownstringMarkdown格式的文本内容
titlestringHTML文件的标题(默认为'Markdown MindMap')
filenamestring生成的HTML文件名(默认为'mindmap.html')

响应

成功响应将返回一个JSON对象,包含以下字段:

字段类型描述
successboolean表示请求是否成功
messagestring描述请求结果的消息
filenamestring实际生成的文件名(含时间戳)
urlstring生成的思维导图HTML文件的访问URL

使用示例

使用cURL

curl -X POST \
  https://your-domain.com/api/markdown-to-mindmap \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: your-api-key-here' \
  -d '{
  "markdown": "# 这是标题\n## 这是子标题\n- 这是列表项\n  - 这是嵌套列表项",
  "title": "我的思维导图",
  "filename": "my-mindmap.html"
}'

使用JavaScript

const response = await fetch('https://your-domain.com/api/markdown-to-mindmap', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'your-api-key-here'
  },
  body: JSON.stringify({
    markdown: '# 这是标题\n## 这是子标题\n- 这是列表项\n  - 这是嵌套列表项',
    title: '我的思维导图',
    filename: 'my-mindmap.html'
  })
});

if (response.ok) {
  // 获取JSON响应
  const data = await response.json();
  
  // 响应示例:
  // {
  //   success: true,
  //   message: "思维导图生成成功",
  //   filename: "my-mindmap-1623456789.html",
  //   url: "https://your-domain.com/mindmaps/my-mindmap-1623456789.html"
  // }
  
  // 使用返回的URL访问生成的思维导图
  window.open(data.url, '_blank');
} else {
  const errorData = await response.json();
  console.error('Error:', errorData);
}

错误代码

状态码描述
400请求格式不正确,缺少必需的参数或Markdown格式错误
401未授权访问,无效的API密钥
500服务器内部错误