「HTML 与 Markdown 互转」是数据鱼API平台提供的双向格式转换接口,Base 路径 /api/htmlmd,共 3 个端点:ping 探活,toMarkdown 把 HTML 转成 Markdown,toHtml 把 Markdown 转成 HTML。它适合内容迁移、CMS 导入导出、把富文本正文降级为纯文本标记,以及给文档站点做格式统一。
两个方向的实现并不同源。toMarkdown 用 DOMDocument 遍历节点树,支持标题、段落、加粗斜体、行内代码、带语言标注的代码块、链接与图片、有序无序及嵌套列表、引用、表格和常见容器标签,script 与 style 的内容直接丢弃而不是转义输出。toHtml 走的是 Markdown 子集解析,覆盖标题、强调、行内代码、带语言 class 的围栏代码块、链接图片、列表、引用、分隔线与段落,不包含表格语法。
安全边界在文档里写得很明确:toHtml 默认转义输入中的原始 HTML,只有显式传 allow_html=1 才保留;toMarkdown 不执行任何脚本与样式;XML 解析启用 LIBXML_NONET,不发起外部实体请求。整个服务基于 PHP 的 ext-dom,不依赖数据库、缓存或外部 HTTP 服务,输入上限 512 KB。
三个端点都要求鉴权,ping 也不例外,只有跨域预检的 OPTIONS 请求免校验。
方法 | 路径 | 说明 | 鉴权 |
|---|---|---|---|
GET | /api/htmlmd/ping | 健康检查,返回版本号与服务器时间 | 是 |
POST | /api/htmlmd/toMarkdown | HTML 转 Markdown | 是 |
POST | /api/htmlmd/toHtml | Markdown 转 HTML | 是 |
X-API-Key 请求头或 ?api_key= 查询参数传递全站统一 Key;缺失返回 4011,无效返回 4013,HTTP 状态 401。html 与 markdown;响应统一为 {"code": 0, "msg": "success", "data": {...}}。msg 说明具体原因。把一段 HTML 片段转为 Markdown 文本,适合把历史富文本正文转成可版本管理的标记文件。
参数 | 类型 | 必填 | 默认 | 说明 |
|---|---|---|---|---|
html | string | 是 | 无 | 待转换的 HTML 文本,最长 512 KB |
返回只有一个字段 markdown,即转换结果。输出保留段落之间的空行,列表项以 - 开头,标题按层级输出 #,加粗与斜体转为 ** 与 *,行内代码用反引号包裹,代码块按 pre/code 的语言 class 写出围栏标注。
{"html": "<h2>标题</h2><p>这是 <strong>加粗</strong>,还有<a href=\"#section\">链接</a>。</p><ul><li>项目一</li></ul>"}转换为 ## 标题、段落一行与一个列表项。script 与 style 标签连同内部文本一起被丢弃,不会被转成可见内容,也不会以 HTML 形式残留在输出里。
把 Markdown 文本渲染为 HTML 片段,用于生成邮件正文、静态页面或富文本编辑器初值。
参数 | 类型 | 必填 | 默认 | 说明 |
|---|---|---|---|---|
markdown | string | 是 | 无 | 待转换的 Markdown 文本,最长 512 KB |
allow_html | string | 否 | 空 | 传 1 时保留输入中的原始 HTML;缺省或不传则转义 |
返回只有一个字段 html。标题输出为 h1 至 h6,强调输出 strong 与 em,围栏代码块输出 pre/code 并附带 language-xxx 类名,列表输出 ul/li,引用输出 blockquote。原始 HTML 默认被实体转义,因此输入里的脚本标签会以文本形式显示;确实需要内嵌 HTML 时再传 allow_html=1,此时应自行保证输入可信。
{"markdown": "# 标题\n\n- 项目一\n- **加粗**\n\n```php\necho 1;\n```", "allow_html": "1"}参数 | 类型 | 必填 | 默认 | 说明 |
|---|---|---|---|---|
无 | — | — | — | 该端点不接受业务参数 |
GET /api/htmlmd/ping返回 code=0、msg=pong,data.version 为接口版本(当前 1.0),data.time 为服务器本地时间,格式 YYYY-MM-DD HH:MM:SS。该端点同样校验 Key,探活请求也必须带上鉴权。
toMarkdown 丢弃 script 与 style 内容;toHtml 默认转义原始 HTML,allow_html=1 才保留。msg 为英文短语,不含多语言文案。allow_html 是字符串而不是布尔值,传 "1" 生效,传 true 或 "true" 的行为文档未定义;开启后原始 HTML 原样保留,必须自行做可信来源校验。msg。toHtml 不会补 html、head、body 等骨架标签,直接当整页返回会缺少文档结构。原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。