终极指南:如何使用 url-to-pdf-api 将网页转换为高质量 PDF 文档

【免费下载链接】url-to-pdf-api Web page PDF/PNG rendering done right. Self-hosted service for rendering receipts, invoices, or any content. 【免费下载链接】url-to-pdf-api 项目地址: https://gitcode.com/gh_mirrors/ur/url-to-pdf-api

url-to-pdf-api 是一款功能强大的自托管服务,专为网页内容渲染设计,能够轻松将任意网页转换为 PDF 或 PNG 格式。无论是收据、发票还是其他网页内容,它都能提供专业级的转换效果,让你快速获取高质量的文档。

为什么选择 url-to-pdf-api?

这款工具基于 Puppeteer 构建,具备诸多优势:

  • 支持单页应用(SPA):会等待所有网络请求完成后再进行渲染,确保内容完整
  • 灵活的输出格式:支持 PDF 和 PNG 两种主要格式,满足不同场景需求
  • 丰富的自定义选项:可调整页面大小、边距、背景打印等多种参数
  • 简单易用的 API:通过简单的 HTTP 请求即可完成转换,无需复杂配置

快速开始:3 步实现网页转 PDF

1. 安装与部署

首先,克隆项目仓库到本地:

git clone https://gitcode.com/gh_mirrors/ur/url-to-pdf-api
cd url-to-pdf-api

然后安装依赖并启动服务:

npm install
npm start

服务将在本地 9000 端口运行,你可以通过 http://localhost:9000 访问。

2. 基本使用方法

使用 GET 请求转换网页非常简单,只需构造如下 URL:

http://localhost:9000/api/render?url=http://example.com

这将返回一个包含 example.com 网页内容的 PDF 文件。

如果你需要 PNG 格式,只需添加 output=screenshot 参数:

http://localhost:9000/api/render?output=screenshot&url=http://example.com

3. 高级自定义选项

url-to-pdf-api 提供了丰富的参数来自定义输出效果:

  • 页面设置:调整尺寸、方向和边距

    ?pdf.format=A5&pdf.landscape=true&pdf.margin.top=2cm
    
  • 延迟渲染:等待指定时间或元素加载完成

    ?waitFor=1000  // 等待 1000ms
    ?waitFor=input  // 等待 input 元素出现
    
  • 滚动页面:触发懒加载内容

    ?scrollPage=true
    

实际应用场景

场景一:保存在线发票

许多在线服务的发票只能在线查看,使用 url-to-pdf-api 可以轻松将其保存为 PDF 文档永久保存:

http://localhost:9000/api/render?url=https://example.com/invoice/12345&attachmentName=invoice-12345.pdf

场景二:批量保存网页内容

通过编写简单的脚本,你可以批量转换多个网页:

const urls = [
  'https://example.com/article1',
  'https://example.com/article2',
  'https://example.com/article3'
];

urls.forEach((url, index) => {
  const apiUrl = `http://localhost:9000/api/render?url=${encodeURIComponent(url)}&attachmentName=article-${index+1}.pdf`;
  // 发起请求并保存文件
});

配置与扩展

核心渲染逻辑

项目的核心渲染功能在 src/core/render-core.js 中实现,主要使用 Puppeteer 控制无头 Chrome 进行页面渲染。你可以根据需要修改此文件来自定义渲染行为。

服务配置

src/config.js 文件包含了服务的主要配置,你可以在这里设置默认参数、端口号等。

中间件扩展

项目提供了基础的中间件支持,你可以在 src/middleware/ 目录下添加自定义中间件来扩展功能,如添加认证、请求限制等。

总结

url-to-pdf-api 是一款功能强大且易于使用的网页转 PDF 工具,无论是个人使用还是集成到企业系统中,都能提供高效、可靠的网页内容转换服务。通过灵活的 API 和丰富的自定义选项,你可以轻松满足各种文档转换需求。

现在就开始使用 url-to-pdf-api,体验快速、高质量的网页转 PDF 服务吧!如需了解更多详细信息,请参考项目的 docs/ 目录下的文档。

【免费下载链接】url-to-pdf-api Web page PDF/PNG rendering done right. Self-hosted service for rendering receipts, invoices, or any content. 【免费下载链接】url-to-pdf-api 项目地址: https://gitcode.com/gh_mirrors/ur/url-to-pdf-api

Logo

小龙虾开发者社区是 CSDN 旗下专注 OpenClaw 生态的官方阵地,聚焦技能开发、插件实践与部署教程,为开发者提供可直接落地的方案、工具与交流平台,助力高效构建与落地 AI 应用

更多推荐