跳转到内容
API 接口文档v2

XML 转 AsciiDoc表格 API

通过TableConvert转换API,由面向记录的XML导出文件准备AsciiDoc表格块。将提取元素文本展示为表格;XML命名空间结构与属性不会渲染成嵌套表结构。

REST APIv2 · 直接返回输出XML → AsciiDoc表格每次成功转换消耗 1 积分

试用这个转换接口

查看真实样例,在浏览器本地预览,或使用自己的密钥发送真实请求。

已验证样例
POSThttps://api.tableconvert.com/v2/convert/xml-to-asciidoc

AsciiDoc表格 响应

[cols="3*", options="header"]
|===============================
| chapter | topic        | pages
| 1       | Introduction | 8    
| 2       | Installation | 12   
|===============================

本地预览不消耗积分,并使用导入的第一个表格或工作表。

转换选项
每次成功的真实请求消耗 1 积分。

密钥仅发送给转换 API,此页面不会保存密钥。

接入前需要确认

接入前请核对

发送XML前,请将所需属性转为明确字段,并展平重复嵌套组。

接入前请核对

此输出为表格标记,不是渲染后的AsciiDoc文档或PDF。

代码示例

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

XML 转 AsciiDoc表格 API · cURL

curl --fail-with-body --max-time 40 \
  'https://api.tableconvert.com/v2/convert/xml-to-asciidoc' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=<?xml version="1.0" encoding="UTF-8" ?>
<dataset>
  <record><chapter>1</chapter><topic>Introduction</topic><pages>8</pages></record>
  <record><chapter>2</chapter><topic>Installation</topic><pages>12</pages></record>
</dataset>' \
  --form-string 'output[minify]=false' \
  --form-string 'output[firstHeader]=true' \
  --form-string 'output[lastFooter]=false' \
  --form-string 'output[title]=' \
  --output 'xml-to-asciidoc.adoc'

需要 cURL。若示例采用文件上传,请先下载输入样例。

身份验证

发送 Authorization: Bearer YOUR_API_KEY。请让 HTTP 客户端设置 multipart 边界,不要手动指定 Content-Type。

生产环境的 API Key 请保存在服务端环境变量中。

请求参数

导入器将文档根元素的每个直接子元素视为记录,再将记录的子元素视为字段;它提取记录,不执行通用XML Schema或XSLT转换。

参数类型默认值说明
datastring—直接发送 XML 表格内容;data、file、url 三种来源任选其一。
filebinary—通过 multipart/form-data 上传 xml 文件。
urlstring—可公开访问的受支持文件 HTTP 或 HTTPS URL。

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

输出选项

生成技术文档中的AsciiDoc表格块;表头、页脚与标题设置控制表格标记,不渲染整篇文档。

参数类型默认值说明
output[minify]booleanfalse减少生成内容的排版空白;请检查该格式对单元格内容的具体影响。
output[firstHeader]booleantrue将表格首行视为文档表头。
output[lastFooter]booleanfalse将末行视为AsciiDoc表格页脚。
output[title]string空字符串为生成的表格输出添加标题。

转换规则

情况处理方式
映射规则 1根元素下的记录子元素提供数据行,其内部子元素名称提供列名并集。
映射规则 2表头与记录变为AsciiDoc单元格,可附带表头及页脚元信息。
映射规则 3将提取元素文本展示为表格;XML命名空间结构与属性不会渲染成嵌套表结构。

输入读取方式

  • 请使用根元素包含重复记录元素、记录内以子元素表示字段的结构。
  • 单元格值来自元素textContent;属性与深层树结构不会自动输出为独立列。
  • 同一记录中重复的字段名会覆盖较早值;请先规范化重复组。
  • 生成代码标识符或新schema前,请检查带命名空间前缀的名称。

输出生成方式

  • 输出使用AsciiDoc表格边界与单元格分隔符。
  • 请根据首行、末行含义设置firstHeader与lastFooter。
  • 请在实际使用的Asciidoctor渲染器中检查字面竖线与多行文本。

适用场景

此转换的实际用途

以面向记录的XML导出文件为起始数据,准备纳入版本管理的技术手册。发送XML前,请将所需属性转为明确字段,并展平重复嵌套组。

AsciiDoc表格

在AsciiDoc手册或发布说明中发布数据表格。

响应与错误

HTTP 状态说明
200text/plain; charset=utf-8
400输入或转换参数无效。
402积分不足,无法处理此请求。
403API Key 缺失或无效。
413输入超过已配置的请求限制。
415不支持的输入媒体类型。
429请求超过频率限制。
500转换未能完成。
503渲染服务不可用或请求超时。

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

限制、计费与版本

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

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

查看 API 定价与积分

仍在使用 API v1?

此页介绍直接返回转换结果的 v2。API v1 使用 JSON 包装响应。调整现有集成前,请先查看 API 总览。

API 总览

参考资料与格式规范

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