Markdown表格 转 Jira Wiki表格 API

代码示例

这些示例以 multipart/form-data 发送样例，并原样保存响应字节。请先设置环境变量 TABLECONVERT_API_KEY。

curl --fail-with-body --max-time 40 \
  'https://api.tableconvert.com/v2/convert/markdown-to-jira' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=| issue  | status      | assignee |
|--------|-------------|----------|
| APP101 | In progress | Alice    |
| APP102 | Done        | Bob      |
' \
  --form-string 'output[escape]=true' \
  --form-string 'output[rowHeader]=true' \
  --form-string 'output[colHeader]=false' \
  --output 'markdown-to-jira.txt'

import os
from pathlib import Path
import requests

endpoint = "https://api.tableconvert.com/v2/convert/markdown-to-jira"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
    "data": (None, "| issue  | status      | assignee |\n|--------|-------------|----------|\n| APP101 | In progress | Alice    |\n| APP102 | Done        | Bob      |\n"),
    "output[escape]": (None, "true"),
    "output[rowHeader]": (None, "true"),
    "output[colHeader]": (None, "false"),
}

response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("markdown-to-jira.txt").write_bytes(response.content)

import { writeFile } from "node:fs/promises";

const form = new FormData();
form.set("data", "| issue  | status      | assignee |\n|--------|-------------|----------|\n| APP101 | In progress | Alice    |\n| APP102 | Done        | Bob      |\n");
form.set("output[escape]", "true");
form.set("output[rowHeader]", "true");
form.set("output[colHeader]", "false");

const response = await fetch("https://api.tableconvert.com/v2/convert/markdown-to-jira", {
  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-jira.txt", Buffer.from(await response.arrayBuffer()));

请求参数

以竖线分隔的Markdown表格行转换为矩形数据集；对齐分隔行会被移除，不作为数据。

使用 data、file 或 url 提供一种输入来源。页面示例使用适合该格式的来源模式。

输出选项

生成可选行表头、列表头的旧版Jira Wiki表格语法；这不是Jira工单创建API或富文本编辑器API。

转换规则

输入读取方式

• 请只提供表格本身；先移除正文、围栏代码示例与无关文档行。
• 解析器会移除识别出的第二行对齐分隔符，并修剪单元格边缘空白。
• 会区分转义竖线与单元格分隔符，但不会将行内Markdown渲染成富文本。
• 每条记录请使用一个物理行，并明确处理多行单元格内容。

输出生成方式

• 表头单元格使用Jira Wiki竖线语法。
• 请根据目标渲染器要求转义字面竖线。
• 请确认Jira字段是否支持Wiki语法；新版编辑器文档可能需要其他表示。

适用场景

响应与错误

重试前请先检查响应。新的 HTTP 请求属于新的转换，可能再次消耗积分。

限制、计费与版本

本地预览最多接受 200 KB。当前 API 实现允许上传一个不超过 50 MiB 的文件，multipart 中每个文本字段限制为 1 MiB，v2 转换任务的截止时间为 30 秒。部署环境可能设置更严格的限制。重试前请先检查错误内容；部分解析或渲染失败会返回 HTTP 500。

真实调用遵循 API 积分规则。转换失败会返还积分；若转换已完成，随后下载连接中断不会撤销该次成功转换。

参考资料与格式规范

格式参考资料用于说明底层语法；上方转换规则与样例描述 TableConvert 的实际实现。

• github.github.com
• jira.atlassian.com