Creating a Nextjs API to Convert HTML to PDF with Puppeteer (Vercel-Compatible)

creating a nextjs api to convert html to pdf with puppeteer (vercel-compatible)

将 html 转换为 pdf 是 web 应用程序中的常见要求。在这篇博文中,我们将探索如何创建一个 next.js api 路由,使用 puppeteer 将 html 转换为 pdf,并确保它在部署到 vercel 时正常工作。

挑战

虽然 puppeteer 是一款功能强大的 html 到 pdf 转换工具,但在部署到 vercel 等无服务器环境时,它带来了挑战。主要问题是:

puppeteer 需要 chromium 二进制文件,这超出了 vercel 的大小限制。无服务器函数的执行时间和资源有限。

解决方案

我们将使用 @sparticuz/chromium-min 和 puppeteer-core 的组合来克服这些限制。我们将采用以下方法:

使用专为无服务器环境设计的最小 chromium 构建。配置 puppeteer 以使用这个最小的 chromium 版本。优化 pdf 生成过程以实现无服务器执行。

第 1 步:设置项目

首先,创建一个新的 next.js 项目或使用现有的项目。然后,安装必要的依赖项:

npm install @sparticuz/chromium-min puppeteer-core

为了确保兼容性和最佳性能,使用所需软件包的正确版本非常重要。截至最新测试,推荐使用以下版本:

{  "dependencies": {    "@sparticuz/chromium-min": "^129.0.0",    "puppeteer-core": "^23.5.0"  }}

第2步:创建api路由

在 app/api/html-to-pdf/route.js (对于 next.js 13+ 应用程序路由器)或 pages/api/html-to-pdf.js (对于 pages 路由器)创建一个新文件。代码如下:

const chromium = require("@sparticuz/chromium-min");const puppeteer = require("puppeteer-core");async function getbrowser() {  return puppeteer.launch({    args: [...chromium.args, "--hide-scrollbars", "--disable-web-security"],    defaultviewport: chromium.defaultviewport,    executablepath: await chromium.executablepath(      `https://github.com/sparticuz/chromium/releases/download/v129.0.0/chromium-v129.0.0-pack.tar`    ),    headless: chromium.headless,    ignorehttpserrors: true  });}export async function post(request) {  try {    const { html } = await request.json();    const browser = await getbrowser();    const page = await browser.newpage();    await page.setcontent(html, { waituntil: "networkidle0" });    const pdfbuffer = await page.pdf({      format: "a4",      printbackground: true,      margin: { top: "1cm", right: "1cm", bottom: "1cm", left: "1cm" }    });    await browser.close();    return new response(pdfbuffer, {      headers: {        "content-type": "application/pdf",        "content-disposition": 'attachment; filename="output.pdf"'      }    });  } catch (error) {    console.error("error generating pdf:", error);    return new response(json.stringify({ error: "failed to generate pdf" }), {      status: 500,      headers: { "content-type": "application/json" }    });  }}

第 3 步:理解代码

让我们分解一下这段代码的关键部分:

立即学习“前端免费学习笔记(深入)”;

浏览器配置

getbrowser 函数使用最小的 chromium 二进制文件设置 puppeteer:

async function getbrowser() {  return puppeteer.launch({    args: [...chromium.args, "--hide-scrollbars", "--disable-web-security"],    defaultviewport: chromium.defaultviewport,    executablepath: await chromium.executablepath(      `https://github.com/sparticuz/chromium/releases/download/v129.0.0/chromium-v129.0.0-pack.tar`    ),    headless: chromium.headless,    ignorehttpserrors: true  });}

此配置使用 @sparticuz/chromium-min 包来提供与无服务器环境兼容的最小 chromium 二进制文件。

pdf 生成

pdf生成的主要逻辑在post函数中:

从请求正文中提取 html。使用 getbrowser 函数启动浏览器实例。创建一个新页面并将其内容设置为提供的 html。从页面内容生成 pdf。关闭浏览器以释放资源。返回 pdf 作为带有适当标题的响应。

第 4 步:使用 api

要使用此 api,请发送 post 请求,并在请求正文中包含 html 内容:

const response = await fetch('/api/html-to-pdf', {  method: 'POST',  headers: {    'Content-Type': 'application/json',  },  body: JSON.stringify({ html: '

Hello, World!

' }),});if (response.ok) { const blob = await response.blob(); // Handle the PDF blob (e.g., download or display)}

部署注意事项

部署到 vercel 时,请记住以下几点:

执行时间:vercel 业余计划的最长执行时间为 10 秒,专业计划的最长执行时间为 60 秒。优化您的 html 和 pdf 生成过程以适应这些限制。

内存使用情况:注意内存使用情况。最小的 chromium 二进制文件会有所帮助,但复杂的 pdf 可能仍会占用大量内存。

冷启动:无服务器函数可能会经历冷启动。第一次调用可能会比较慢,因为它需要下载并设置 chromium 二进制文件。

错误处理:实施强大的错误处理来管理超时或资源限制。

缓存:考虑对频繁生成的 pdf 实施缓存策略,以减少无服务器函数的负载。

结论

这种方法允许您使用 next.js 和 puppeteer 创建功能强大的 html 到 pdf 转换 api,与 vercel 的无服务器环境兼容。通过利用 @sparticuz/chromium-min 和 puppeteer-core,我们克服了在无服务器环境中运行 puppeteer 的主要挑战。

以上就是Creating a Nextjs API to Convert HTML to PDF with Puppeteer (Vercel-Compatible)的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1493157.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
了解如何从头开始构建人工智能辅助博客
上一篇 2025年12月19日 15:27:03
JavaScript 字符串操作:如何使用拆分、反转和连接
下一篇 2025年12月19日 15:27:25

相关推荐

  • 开源免费PHP工具 PHP开发效率提升利器

    推荐开源免费PHP开发工具以提升效率:VS Code、Sublime Text轻量高效,PhpStorm专业强大;调试用Xdebug、Kint、Ray;依赖管理选Composer;代码质量工具包括PHPStan、Psalm、PHP_CodeSniffer;数据库管理可用%ignore_a_1%MyA…

    2026年5月10日
    000
  • 谷歌浏览器如何截图 谷歌浏览器页面截图技巧

    谷歌浏览器如何截图 谷歌浏览器页面截图技巧谷歌浏览器如何截图 谷歌浏览器页面截图技巧谷歌浏览器如何截图 谷歌浏览器页面截图技巧谷歌浏览器如何截图 谷歌浏览器页面截图技巧

    使用谷歌浏览器的开发者工具截图步骤:1. 按ctrl+shift+i(windows/linux)或cmd+option+i(mac)打开开发者工具。2. 点击右上角三个点,选择”更多工具”,再选择”截图”。3. 选择截取整个页面。推荐的谷歌浏览器扩展…

    2026年5月10日 用户投稿
    100
  • JavaScript计算器开发:解决数值显示与初始化问题

    本教程深入探讨了使用JavaScript构建计算器时常见的数值显示异常问题,特别是由于类属性未初始化导致的`Cannot read properties of undefined`错误。我们将详细分析问题根源,并通过在构造函数中调用初始化方法来解决该问题,同时优化显示逻辑,确保计算器功能稳定且界面显…

    2026年5月10日
    000
  • NextAuth getToken 在服务端返回 null 的问题排查与解决

    问题描述 在使用 Next.js 和 NextAuth 构建应用程序时,有时需要在服务端获取用户的身份验证信息。getToken 函数是 NextAuth 提供的一个便捷方法,用于从请求中提取 JWT (JSON Web Token)。然而,在某些情况下,尤其是在使用 getServerSidePr…

    2026年5月10日
    000
  • HTML文档如何工作?如何编辑HTML格式文件?

    HTML文档如何工作?如何编辑HTML格式文件?HTML文档如何工作?如何编辑HTML格式文件?HTML文档如何工作?如何编辑HTML格式文件?HTML文档如何工作?如何编辑HTML格式文件?

    浏览器解析和渲染html的过程包括:1. 解析html构建dom树;2. 结合css构建渲染树;3. 布局计算元素位置;4. 绘制像素到屏幕。编辑html可使用记事本、vs code、sublime text等文本或代码编辑器,其中vs code因语法高亮、自动补全和插件生态成为主流选择。标准htm…

    2026年5月10日 用户投稿
    000
  • GolangWeb项目异常捕获与日志记录

    答案:通过中间件使用defer和recover捕获panic,结合zap等结构化日志库记录请求链路信息,为每个请求生成trace ID,实现异常捕获与可追踪日志,提升系统稳定性与可观测性。 在Go语言Web项目中,异常捕获与日志记录是保障系统稳定性和可维护性的关键环节。Go本身没有像其他语言那样的t…

    2026年5月10日
    000
  • Python官网用户调查的参与方式_Python官网反馈提交详细教程

    答案是通过访问Python官网新闻页面、邮件邀请链接或GitHub仓库提交反馈。具体为:访问官网查找用户调查公告,或点击邮件中的专属链接参与,在GitHub的cpython仓库提交技术建议,并注意如实填写问卷与保护隐私。 如果您希望参与Python官网的用户调查并提交反馈,可以通过官方指定的渠道完成…

    2026年5月10日
    000
  • Go语言连接外部MySQL数据库:DSN配置与常见错误解析

    本文详细阐述了go语言使用`go-sql-driver/mysql`驱动连接外部mysql数据库的正确方法。重点介绍了数据源名称(dsn)的规范格式,特别是主机地址部分的配置,以避免常见的“getaddrinfow: the specified class was not found.”等网络解析错…

    2026年5月10日
    000
  • Tensorflow 音乐预测

    在本文中,我展示了如何使用张量流来预测音乐风格。在我的示例中,我比较了电子音乐和古典音乐。 你可以在我的github上找到代码:https://github.com/victordalet/sound_to_partition i – 数据集 第一步,您需要创建一个数据集文件夹,并在里面…

    2026年5月10日
    000
  • 学习了Python的Flask后,Go语言的Web框架该选Gin还是Beego?

    学习编程时,选择合适的框架至关重要。许多开发者在掌握Python Flask后,转向Go语言Web开发时,常常在Gin和Beego之间难以抉择。本文将深入分析,助您做出明智选择。 虽然网上搜索结果多建议使用Go原生标准库http,但实际上所有框架都是对http的封装。虽然使用http开发灵活,但工作…

    2026年5月10日
    000
  • JavaScript动态下拉菜单:实现日期选项与价格计算关联

    在现代web应用中,动态生成表单元素并使其具备交互逻辑是常见的需求。特别是在需要根据用户选择调整价格或服务参数的场景下,下拉菜单()常被用来展示一系列选项。本教程将指导您如何利用javascript动态生成一个包含日期选项的下拉菜单,并为每个选项关联一个具体的数值(如剩余天数),进而实现一个基于用户…

    2026年5月10日
    000
  • 如何在不暴露密钥的情况下,在客户端创建 Stripe Payment Link

    本文介绍了在纯静态网站环境下,如何利用 Stripe Payment Link 实现商品售卖,并着重讨论了在不暴露 Stripe 密钥的前提下,客户端创建 Payment Link 的可行性。分析了直接在客户端使用密钥的风险,并提出了预先生成 Payment Link 或使用后端服务动态生成 Pay…

    2026年5月10日
    000
  • 解决Go语言中GOPATH未设置错误及工作区配置指南

    本文旨在解决go语言开发中常见的“gopath not set”错误,并提供详细的go工作区配置指南。内容涵盖`gopath`环境变量的设置、go项目目录结构、`path`变量的扩展,以及一些高级配置技巧,旨在帮助开发者建立一个高效、规范的go开发环境,确保包的下载、编译和运行顺利进行。 Go语言在…

    2026年5月10日
    000
  • 掌握 JavaScript 中的高阶函数

    现代 javascript 开发严重依赖函数式编程,掌握其基本思想将极大提高你的编码能力。 高阶函数是这个范式最有力的武器之一。为了帮助您掌握它们,本文将介绍它们的定义、应用程序和独特的实现。 1. 函数式编程 函数式编程是一种编程范式,强调: 纯函数:没有副作用的函数,对于相同的输入返回相同的输出…

    2026年5月10日
    000
  • Golang使用assert库简化测试断言

    使用testify/assert库可提升Go测试代码的可读性和效率,通过go get github.com/stretchr/testify/assert安装后导入包,用assert.Equal等函数替代冗长的手动判断,支持丰富断言方法如Equal、True、Nil、Contains等,并可添加自定…

    2026年5月10日
    100
  • 如何处理在线编辑HTML时外部链接验证的处理方法

    在线编辑HTML时需验证外部链接以保障安全与可用性,可通过自动检测标记外链并添加rel属性提升安全性;2. 实时验证链接有效性,利用HEAD请求检查状态码并在编辑界面提示结果;3. 配置可信域名白名单控制高风险链接输入,适用于合规要求高的场景;4. 提供友好反馈机制,对无效或可疑链接弹出提示并支持新…

    2026年5月10日
    000
  • 怎样为C++配置嵌入式AI开发环境 TensorFlow Lite Micro移植指南

    怎样为C++配置嵌入式AI开发环境 TensorFlow Lite Micro移植指南怎样为C++配置嵌入式AI开发环境 TensorFlow Lite Micro移植指南怎样为C++配置嵌入式AI开发环境 TensorFlow Lite Micro移植指南怎样为C++配置嵌入式AI开发环境 TensorFlow Lite Micro移植指南

    要在c++++项目中使用tensorflow lite micro进行嵌入式ai开发,关键步骤包括:1. 确定mcu平台并安装对应的交叉编译工具链;2. 配置python环境并安装必要的依赖包;3. 获取并裁剪tflm源码,保留核心模块;4. 将tflm静态库集成到c++工程中;5. 按照模型加载、…

    2026年5月10日 用户投稿
    000
  • Golang图片处理技巧 imaging库裁剪缩放

    答案:使用Go语言的imaging库可高效实现图片裁剪与缩放,其API简洁易用,支持多种缩放算法(如Lanczos、CatmullRom)以平衡质量与性能,提供Crop和CropAnchor两种裁剪方式实现精确区域控制,并建议通过算法选择、内存管理、并发处理和错误校验等策略优化性能与稳定性。 在Go…

    2026年5月10日
    000
  • 如何通过GitHub API高效获取超过100个用户列表(分页教程)

    本教程旨在解决使用GitHub API获取用户列表时遇到的默认100个用户限制问题。我们将详细介绍两种主要的分页策略:利用Octokit库内置的paginate方法实现自动化分页,以及手动实现基于since参数的循环分页逻辑。文章将提供清晰的代码示例,并强调在不同场景下选择合适方法的注意事项,特别是…

    2026年5月10日
    100
  • c语言里面字符是什么意思

    字符在 C 语言中以单个字节存储于 char 变量中,用单引号括起表示常量,例如 ‘A’。字符变量用于存储字符值,可使用函数如 putchar() 输出、getchar() 输入、toupper() 转换大小写。字符数组存储多个字符,如 char name[10]。字符串是带…

    2026年5月10日
    000

发表回复

登录后才能评论
关注微信