使用教程

1. 基础入门:变量替换

在您的 Word (.docx) 或 Excel (.xlsx) 模板中,任何使用双大括号 包围的文本都会被视为一个变量。

模板示例 (Word):

尊敬的 {{ customer_name }},感谢您的订单,订单号为 {{ order_id }}。

对应的 JSON 数据:


{
  "customer_name": "张三",
  "order_id": "2023-A001"
}
                

生成结果:

尊敬的 张三,感谢您的订单,订单号为 2023-A001。


2. 图片替换

您可以在模板中插入一张占位图片,并通过 JSON 数据将其替换为指定的图片。

  1. 在 Word 中,右键点击您要替换的图片,选择“编辑替换文字”(Edit Alt Text)。
  2. 在替换文字输入框中,填入一个以 img_ 开头的标识符,例如 img_user_avatar
  3. 在 JSON 数据中,提供一个键值对,键是您设置的标识符,值是图片的公开 URL 或服务器上的绝对路径。

对应的 JSON 数据:


{
  "img_user_avatar": "https://example.com/path/to/your/image.png"
}
                

3. 动态表格 (行循环)

对于需要动态增减行数的表格,您可以在模板中定义一个循环区域。

模板示例 (Word 表格的一行):

产品数量单价
{% for item in products %}
{{ item.name }}{{ item.quantity }}{{ item.price }}
{% endfor %}

注意:请将 \{\% ... \%\} 标签放在表格单元格内。系统会自动复制 forendfor 之间的所有行。

对应的 JSON 数据:


{
  "products": [
    { "name": "产品A", "quantity": 2, "price": "100.00" },
    { "name": "产品B", "quantity": 5, "price": "45.50" },
    { "name": "产品C", "quantity": 1, "price": "300.00" }
  ]
}
                

4. API 调用示例

您可以通过编程方式调用我们的 RESTful API 来生成文档。请在您的个人中心获取 API Token。

使用 cURL:


curl -X POST https://your-domain.com/api/generate/ \
     -H "Authorization: Token YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "template_id": 123,
           "context": {
             "customer_name": "API 用户",
             "order_id": "API-002"
           }
         }'