4teamwork/sablon

sablon

镜像概述和主要用途

sablon是一个Docker化的Web服务，用于从模板创建Microsoft Word文档。它基于Ruby Gem https://github.com/senny/sablon%E5%AE%9E%E7%8E%B0%E6%96%87%E6%A1%A3%E7%94%9F%E6%88%90%E5%8A%9F%E8%83%BD%EF%BC%8C%E5%B9%B6%E9%80%9A%E8%BF%87Python aiohttp Web服务器暴露HTTP端点，接收上传的.docx模板文件和JSON上下文数据，动态生成Word文档。

核心功能和特性

• 基于sablon Ruby Gem实现专业的Word文档生成
• 提供HTTP端点，支持通过multipart/form-data上传模板和上下文
• 使用Python aiohttp构建，轻量高效的Web服务
• 支持动态将JSON数据填充到Word模板中

使用场景和适用范围

适用于需要通过API动态生成Word文档的场景，如：

• 自动化报表生成
• 合同、协议等文档的批量创建
• 动态生成包含个性化数据的文档
• 集成到业务系统中实现文档自动化

使用方法和配置说明

启动服务

通过docker-compose启动服务：

docker-compose up

文档生成请求

服务暴露HTTP端点，接收multipart/form-data格式的请求，包含两个部分：

• template: .docx格式的模板文件
• context: JSON格式的上下文数据

请求示例

使用curl发送请求：

bash
curl -F "template=@tests/template.docx" -F "context=@tests/context.json" http://localhost:3000/

测试说明

执行测试需要Python 3.8环境，并安装pytest和requests依赖：

bash
python3.8 -m venv venv
source venv/bin/activate  # Linux/macOS
# 或在Windows上使用: venv\Scripts\activate
pip install pytest requests

运行测试：

bash
pytest