Skip to content

端点

/api/template/render

渲染模板

源文件 (GitHub)

需要认证

接口描述

使用 Go template 语法渲染给定的模板字符串。模板中可以包含变量、条件判断、循环等。

请求参数

参数名类型必选描述
pathstring模板文件的绝对路径。
datastring用于渲染模板的 JSON 字符串数据。
idstring关联的块 ID,用于模板内部获取上下文信息(例如 \{\{.Block.ID\}\})。

返回值

返回渲染后的结果字符串。

参数名类型描述
codenumber返回码,0表示成功
msgstring返回信息
datastring渲染后的模板内容。

请求示例 (cURL)

返回示例

请求示例 (cURL)

curl -X POST \
  http://127.0.0.1:6806/api/template/render \
  -H 'Authorization: Token YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "path": "/Users/user/Documents/SiYuan/templates/my_template.md",
    "data": "{\"name\": \"思源笔记\", \"version\": \"3.0.0\"}",
    "id": "20231027160000-abcdef"
}'

假设 `my_template.md` 内容为:

你好,\{\{.name\}\}!当前版本是 \{\{.version\}\}。关联块ID:\{\{.Block.ID\}\}

返回示例

json
{
    "code": 0,
    "msg": "",
    "data": "你好,思源笔记!当前版本是 3.0.0。关联块ID:20231027160000-abcdef"
}