接入前需要确认
接入前请核对
请只发送竖线表格,并检查值中的转义竖线与行内格式。
接入前请核对
生成标记需要由应用嵌入并添加样式;它不是完整渲染页面。
代码示例
这些示例以 multipart/form-data 发送样例,并原样保存响应字节。请先设置环境变量 TABLECONVERT_API_KEY。
Markdown表格 转 HTML表格 API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/markdown-to-html' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data=| department | owner | status |
|------------|-------|--------|
| Support | Alice | Ready |
| Sales | Bob | Review |
' \
--form-string 'output[colHeader]=false' \
--form-string 'output[minify]=false' \
--form-string 'output[thead]=false' \
--form-string 'output[escape]=true' \
--form-string 'output[div]=false' \
--form-string 'output[tableCaption]=' \
--output 'markdown-to-html.html'需要 cURL。若示例采用文件上传,请先下载输入样例。
Markdown表格 转 HTML表格 API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/markdown-to-html"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "| department | owner | status |\n|------------|-------|--------|\n| Support | Alice | Ready |\n| Sales | Bob | Review |\n"),
"output[colHeader]": (None, "false"),
"output[minify]": (None, "false"),
"output[thead]": (None, "false"),
"output[escape]": (None, "true"),
"output[div]": (None, "false"),
"output[tableCaption]": (None, ""),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("markdown-to-html.html").write_bytes(response.content)需要 Python 3 与 requests,可通过 pip install requests 安装。
Markdown表格 转 HTML表格 API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "| department | owner | status |\n|------------|-------|--------|\n| Support | Alice | Ready |\n| Sales | Bob | Review |\n");
form.set("output[colHeader]", "false");
form.set("output[minify]", "false");
form.set("output[thead]", "false");
form.set("output[escape]", "true");
form.set("output[div]", "false");
form.set("output[tableCaption]", "");
const response = await fetch("https://api.tableconvert.com/v2/convert/markdown-to-html", {
method: "POST",
headers: { Authorization: "Bearer " + process.env.TABLECONVERT_API_KEY },
body: form,
signal: AbortSignal.timeout(40_000),
});
if (!response.ok) {
throw new Error("HTTP " + response.status + ": " + await response.text());
}
await writeFile("markdown-to-html.html", Buffer.from(await response.arrayBuffer()));需要 Node.js 20 或更新版本,使用内置 fetch、FormData 和 Blob。
身份验证
发送 Authorization: Bearer YOUR_API_KEY。请让 HTTP 客户端设置 multipart 边界,不要手动指定 Content-Type。
生产环境的 API Key 请保存在服务端环境变量中。
请求参数
以竖线分隔的Markdown表格行转换为矩形数据集;对齐分隔行会被移除,不作为数据。
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
data | string | — | 直接发送 Markdown 表格内容;data、file、url 三种来源任选其一。 |
file | binary | — | 通过 multipart/form-data 上传 md 文件。 |
url | string | — | 可公开访问的受支持文件 HTTP 或 HTTPS URL。 |
使用 data、file 或 url 提供一种输入来源。页面示例使用适合该格式的来源模式。
输出选项
根据表格网格生成HTML表格标记;表头、转义、标题与div形式选项只影响标记,不生成完整网站。
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
output[colHeader] | boolean | false | 使用目标表格语法将首列标为表头单元格。 |
output[minify] | boolean | false | 减少生成内容的排版空白;请检查该格式对单元格内容的具体影响。 |
output[thead] | boolean | false | 在目标标记中生成明确的表头及表体分节。 |
output[escape] | boolean | true | 单元格应保持纯文本时,转义目标标记中具有特殊含义的字符。 |
output[div] | boolean | false | 使用基于div的HTML类表格标记,而非语义化table元素。 |
output[tableCaption] | string | 空字符串 | 为生成的HTML表格添加标题。 |
转换规则
| 情况 | 处理方式 |
|---|---|
| 映射规则 1 | Markdown表头与正文行保留为数据,仅用于对齐的分隔行被丢弃。 |
| 映射规则 2 | 将规范化单元格包装为表格行与单元格元素。 |
| 映射规则 3 | 转换解析后的网格,而非整篇Markdown文档;源对齐语法会被目标表格规则替代。 |
输入读取方式
- 请只提供表格本身;先移除正文、围栏代码示例与无关文档行。
- 解析器会移除识别出的第二行对齐分隔符,并修剪单元格边缘空白。
- 会区分转义竖线与单元格分隔符,但不会将行内Markdown渲染成富文本。
- 每条记录请使用一个物理行,并明确处理多行单元格内容。
输出生成方式
- 单元格文本成为th或td内容,可选thead处理。
- 不可信纯文本请保持开启转义,并检查任何有意保留的HTML。
- 不重建原来源CSS、交互与合并单元格布局。
适用场景
此转换的实际用途
以README或文档表格为起始数据,准备应用表格视图或报告模板。请只发送竖线表格,并检查值中的转义竖线与行内格式。
HTML表格
将生成的数据表嵌入应用视图或报告模板。
响应与错误
| HTTP 状态 | 说明 |
|---|---|
200 | text/plain; charset=utf-8 |
400 | 输入或转换参数无效。 |
402 | 积分不足,无法处理此请求。 |
403 | API Key 缺失或无效。 |
413 | 输入超过已配置的请求限制。 |
415 | 不支持的输入媒体类型。 |
429 | 请求超过频率限制。 |
500 | 转换未能完成。 |
503 | 渲染服务不可用或请求超时。 |
重试前请先检查响应。新的 HTTP 请求属于新的转换,可能再次消耗积分。
限制、计费与版本
本地预览最多接受 200 KB。当前 API 实现允许上传一个不超过 50 MiB 的文件,multipart 中每个文本字段限制为 1 MiB,v2 转换任务的截止时间为 30 秒。部署环境可能设置更严格的限制。重试前请先检查错误内容;部分解析或渲染失败会返回 HTTP 500。
真实调用遵循 API 积分规则。转换失败会返还积分;若转换已完成,随后下载连接中断不会撤销该次成功转换。
查看 API 定价与积分参考资料与格式规范
格式参考资料用于说明底层语法;上方转换规则与样例描述 TableConvert 的实际实现。