What is Gotenberg?

  1. 项目基础介绍
    Gotenberg 是一个基于Docker的开源项目,提供了一种开发者友好的API,用于将多种文档格式转换为PDF文件。该项目主要使用 Go 语言开发,并利用Docker容器化技术进行部署。

  2. 项目核心功能
    文档转换:支持将HTML、Markdown、Word、Excel等多种文档格式转换为PDF。
    工具集成:集成了Chromium、LibreOffice等强大的工具,为转换提供底层支持。
    API接口:提供简洁的API接口,便于开发者快速集成和使用。
    Docker支持:可以通过Docker容器运行,方便部署和扩展。

  3. 项目最近更新的功能
    性能优化:对API接口进行了性能优化,提高了处理速度和效率。
    错误处理:增强了错误处理机制,提高了API的稳定性和可靠性。
    文档完善:更新了项目文档,增加了更多示例和指导,帮助开发者更好地理解和使用API。
    安全性增强:对代码进行了安全审计,修复了潜在的安全问题,确保了API的安全性。

https://gotenberg.dev/docs/configuration

Gotenberg 是一个开源的文档转换服务,使用 Chromium 和 LibreOffice 支持将多种文档格式(HTML、Markdown、Word、Excel 等)转换为PDF。

安装
这里我们使用docker来快速安装与运行gotenberg。

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

安装完成后,我们可以通过访问 http://localhost:3000 来使用 gotenberg 的 API。 实际请求地址请根据服务器ip和使用的端口进行调整。

使用
Gotenberg提供了 HTTP API,你可以通过发送 HTTP 请求来使用它。

下面是Gotenberg 的 API文档 的一下简单使用示例,更多的API你可以通过访问 官方文档 来进行查看。

安装
这里我们使用docker来快速安装与运行gotenberg。

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

安装完成后,我们可以通过访问 http://localhost:3000 来使用 gotenberg 的 API。 实际请求地址请根据服务器ip和使用的端口进行调整。

使用
Gotenberg提供了 HTTP API,你可以通过发送 HTTP 请求来使用它。

下面是Gotenberg 的 API文档 的一下简单使用示例,更多的API你可以通过访问 官方文档 来进行查看。
1.网页地址(URL)转PDF
请求路由:
POST /forms/chromium/convert/url
请求参数 multipart/form-data:
参数名 类型 是否必须 说明
url string 是 要转换的网页地址(URL)地址
示例

curl \
--request POST http://localhost:3000/forms/chromium/convert/url \
--form url=https://my.url \
-o my.pdf

postman 模拟请求结果

2.HTML转PDF
请求路由:
POST /forms/chromium/convert/html
请求参数 multipart/form-data:
参数名 类型 是否必须 说明
files file 是 index.html文件
注意:上传的 html 名称必须为 index.html

示例

curl \
--request POST http://localhost:3000/forms/chromium/convert/html \
--form files=@/path/to/index.html \
-o my.pdf

postman模拟请求结果

文档更新时间: 2025-05-09 05:52   作者:月影鹏鹏
IT运维支持-AIWALY-月影工作室