首页
/ 终极Gotenberg文档转换API指南:快速上手JavaScript SDK使用教程

终极Gotenberg文档转换API指南:快速上手JavaScript SDK使用教程

2026-02-05 04:39:30作者:鲍丁臣Ursa

Gotenberg是一个强大的开源文档转换API,能够将HTML、Markdown、Word、Excel等数十种文档格式转换为PDF文件。这个开发者友好的API基于Chromium和LibreOffice构建,为开发者提供了简单高效的文档处理解决方案。😊

🚀 Gotenberg核心功能介绍

Gotenberg的核心功能是通过RESTful API提供文档转换服务。它支持多种转换引擎:

  • Chromium引擎:用于HTML、Markdown到PDF的转换
  • LibreOffice引擎:用于Office文档到PDF的转换
  • PDF处理引擎:支持PDF合并、拆分、加密等操作

快速安装步骤

使用Docker快速启动Gotenberg服务:

docker run --rm -p 3000:3000 gotenberg/gotenberg:8

服务启动后,API将在http://localhost:3000 上可用。

📋 支持的文档格式

Gotenberg支持广泛的文档格式转换,包括但不限于:

  • 文本格式:.txt, .html, .htm, .md
  • Office文档:.doc, .docx, .xls, .xlsx, .ppt, .pptx
  • 图像格式:.jpg, .png, .gif, .bmp
  • 其他格式:.epub, .rtf, .csv

🔧 API接口使用方法

HTML转PDF接口调用

使用JavaScript调用HTML转PDF接口:

const formData = new FormData();
formData.append('files', htmlFile);
formData.append('landscape', 'false');

const response = await fetch('http://localhost:3000/forms/chromium/convert/html', {
  method: 'POST',
  body: formData
});

Markdown转PDF配置

Markdown转换支持自定义页眉页脚:

formData.append('header', headerHtmlFile);
formData.append('footer', footerHtmlFile);

⚙️ 高级配置选项

Gotenberg提供了丰富的配置选项来满足不同的转换需求:

页面布局设置

  • 页面方向(横向/纵向)
  • 页边距调整
  • 纸张尺寸自定义

转换质量控制

  • 图像压缩质量设置
  • PDF格式优化(PDF/A、PDF/UA)
  • 水印和加密功能

🛠️ 集成到现有项目

将Gotenberg集成到现有JavaScript项目非常简单:

  1. 安装依赖:无需额外npm包
  2. 配置API端点:设置正确的服务地址
  3. 处理响应:接收转换后的PDF文件

📊 性能优化建议

为了获得最佳的文档转换性能,建议:

  • 使用合适的超时设置
  • 配置合理的并发限制
  • 优化输入文件大小

🔍 故障排除指南

常见问题及解决方案:

  • 转换失败:检查输入文件格式是否支持
  • 内存不足:调整Docker容器资源限制
  • 网络超时:适当增加请求超时时间

🎯 实际应用场景

Gotenberg适用于多种业务场景:

  • 报表生成:将数据转换为PDF报表
  • 文档处理:批量转换文档格式
  • Web应用:在线文档预览和下载

通过这个完整的Gotenberg文档转换API使用指南,您可以快速上手并集成到自己的项目中,实现高效的文档处理功能。

登录后查看全文
热门项目推荐
相关项目推荐