← 返回 MdMonitor 首页

BUILD LOG

MdMonitor 本地 REST API 实战指南

2026-03-06 · 自 v0.6.7 起可用

这次我们把 MdMonitor 从“纯剪贴板被动监听”扩展成了“可被外部系统主动调用”的工具。

v0.6.7 开始,你可以通过本地 HTTP 接口:

  • 提交一段 Markdown 链接内容并触发采集/写入/克隆
  • 获取指定日期的 links_yyyyMMdd.md 内容
  • 查询服务健康状态

为什么要做这个能力

核心原因很简单:把 MdMonitor 接进你的自动化链路。

例如:

  • 浏览器扩展抓到链接后直接 POST 给 MdMonitor
  • 个人脚本把「今天想跟进的仓库」批量送入 MdMonitor
  • 其它本地应用把结构化信息转成 Markdown 链接后复用同一条处理链路

这样你不用再手动“复制到剪贴板触发”。

安全边界(默认本地)

REST API 默认设计是“本地优先”:

  • 默认监听地址:127.0.0.1
  • 默认端口:18731
  • 必须带 Token 鉴权

鉴权支持三种方式(满足任意一种即可):

  1. Authorization: Bearer <token>
  2. X-MDM-Token: <token>
  3. query 参数 ?token=<token>(不推荐,仅兼容)

建议只在明确需要时才改成 0.0.0.0 暴露到局域网。

接口清单

1) 健康检查

  • GET /api/v1/health
curl "http://127.0.0.1:18731/api/v1/health" \
  -H "Authorization: Bearer <token>"

2) 提交 Markdown 链接内容

  • POST /api/v1/capture
  • Content-Type: application/json
  • body 可用 markdowncontent 字段
curl -X POST "http://127.0.0.1:18731/api/v1/capture" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"markdown":"[repo](https://github.com/owner/repo)"}'

返回里会包含:识别数量、写入数量、克隆数量、跳过数量、目标文件路径。

3) 获取某天内容

  • GET /api/v1/daily?date=yyyy-MM-dd
  • 不传 date 默认返回今天
curl "http://127.0.0.1:18731/api/v1/daily?date=2026-03-06" \
  -H "X-MDM-Token: <token>"

设置入口

你可以在应用设置页的 System 分组看到 REST 相关配置:

  • 启用本地 REST API
  • 监听地址
  • 端口
  • Token(支持一键随机生成)

版本信息

  • Available since v0.6.7
  • 关联提交:0f4c5ff(REST API 功能),b71823a(release)

如果你已经把 MdMonitor 接进自己的自动化流程,欢迎继续反馈你的场景,我们会持续把这套接口做得更稳定、可编排。