接口
插件对外提供以下自定义接口(需登录控制台,随插件权限校验):
| 方法 | 路径 | 说明 |
|---|---|---|
POST | /apis/api.wechat-sync.halo.run/v1alpha1/sync | 提交同步任务,立即返回 202,后台异步执行;同一文章「同步中」时重复提交返回 409 |
POST | /apis/api.wechat-sync.halo.run/v1alpha1/validate | 同步前预检:返回 {"errors": [...]},校验微信配置(AppID / AppSecret)、封面图与文章是否正在同步中;空数组表示通过(不调用微信接口、不落库) |
POST | /apis/api.wechat-sync.halo.run/v1alpha1/preview | 按与同步一致的规则美化正文,并返回上传后将使用的标题(截断到 64 字)、作者(8 字)、摘要(120 字)、原文链接与留言设置,以及 truncatedFields(被截断的字段名:title / author / digest),供确认前预览与截断标识(不调用微信接口、不落库) |
GET | /apis/api.wechat-sync.halo.run/v1alpha1/status | 返回全部文章的最近同步状态,键为文章 name |
POST /sync 请求体示例:
{
"postName": "my-post",
"title": "文章标题",
"digest": "摘要",
"content": "<p>渲染后的正文 HTML</p>",
"cover": "/upload/cover.jpg",
"author": "作者名",
"permalink": "/archives/my-post"
}