HTML转markdown-文档转Markdown-docx转markdown API接口介绍
来源:互联网
时间:2026-06-26 12:35:40
前言
日常办公和系统开发中,经常要面对Word、HTML等格式转Markdown的需求——知识库沉淀、接口文档整理、项目说明写作,哪样都绕不开。手动转换?费时费力不说,格式错乱、图片丢失、排版不统一简直是家常便饭。更何况不同文档的标签和样式差异,光是清理冗余就能让人头大。为了解决这些痛点,设计了一套文档与HTML转Markdown的方案:通过解析文档结构、过滤冗余样式标签、统一标题/表格/列表等排版规则,自动完成格式转换,同时完整保留原文内容结构。这套转换工具能快速适配技术文档、业务资料等常见场景,大幅提升整理效率,保障多平台下的文档格式统一,方便在线查阅和版本管理。

应用场景
项目知识库场景
接口开发场景
技术博文创作
企业资料整理
开源项目维护
API介绍
请求参数
| 名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
| appId | String | 是 | 服务商分配的唯一标识。 |
| timestamp | Long | 是 | 当前时间毫秒数。 |
| sign | String | 是 | 签名,详见签名算法说明。 |
| html | String | 否 | 待转换的 HTML 内容。html、file、url 至少传一个;优先级:file > url > html。 |
| file | File | 否 | 待转换文件,支持 .html、.htm、.docx,文件大小限制 3M 以内。Word 文件仅支持 .docx,不支持 .doc。html、file、url 至少传一个;传 file 时优先处理文件。 |
| url | String | 否 | Word .docx 文档公网地址,仅支持 .docx 文件,不支持 .doc,文件大小限制 3M 以内。html、file、url 至少传一个;仅在未传 file 时生效。 |
| imageMode | String | 否 | 图片处理模式:zip 图片单独解析并打包返回 .zip;base64 图片内嵌到 Markdown 并返回 .md;不传默认 zip。 |
返回样例
{ "code": 200,// 返回码,详见code返回码说明"msg": "成功",// code对应的描述"taskNo": "193000000000000000000001",// 本次请求号"charge": true,// 计费标志"data": { "url": "https://file.jumdata.com/office/html-to-markdown/20260604/xxxxxxxx.zip"// 压缩包地址,内含 md 文件和图片文件}
}