跳到內容
getnextpdf.com

指南

這些指南說明如何將 NextPDF 整合到程式碼實際執行的環境中。本頁先從生產環境維運檢查清單開始,接著依導入順序涵蓋五大領域:框架與 renderer(渲染器)整合、NextPDF Connect 伺服器、Python SDK、引擎擴充套件開發,以及疑難排解。以下每個章節都會先列出對應的中樞頁,再列出最常用的頁面。

若你需要可直接複製、依任務整理的 recipe(範例),請參閱 Cookbook(範例指南)。若你需要已驗證的 API 與支援矩陣,請參閱 參考資料

八個套件會將核心引擎連接至框架、瀏覽器 renderer(渲染器)、邊緣服務、建構工具,以及舊系統移轉路徑。每個套件章節都採用相同的手冊結構——概觀、安裝、快速上手、組態、API、開發者指南、生產環境使用、安全性,以及疑難排解——因此只要熟悉其中一個,就能掌握其餘章節的閱讀方式。

頁面用途
整合擴充套件地圖與選用指南。請先閱讀本頁,再挑選套件。
整合 API 索引說明各框架、renderer(渲染器)、傳輸與建構工具介面分別對應到哪一個擴充套件 API 頁面。
Laravel 整合Laravel 框架轉接器。
Symfony 整合Symfony 框架轉接器。
適用於 CodeIgniter 的 NextPDFCodeIgniter 框架轉接器。
NextPDF Artisan用於瀏覽器等級 HTML 渲染的 Chrome renderer(渲染器)橋接器。
NextPDF Cloudflare在 Cloudflare 上部署至邊緣的路徑。
NextPDF GotenbergGotenberg renderer(渲染器)橋接器。
TCPDF 相容性為正在從 TCPDF 移轉的程式碼庫提供相容 shim(相容層)。
NextPDF Backport Builder(回溯建構工具)針對較舊 PHP 執行環境的建構工具。

nextpdf/server 套件會以長時間執行服務的形式啟動引擎:透過一份確定性的工具登錄表,經由 Model Context Protocol(MCP)、具象狀態傳輸(REST)與 gRPC 提供服務,並在呼叫高風險工具前加入一道 human-in-the-loop 確認 gate。

頁面用途
NextPDF Connect本章節的中樞頁:伺服器的概念、組態與維運。
Connect 總覽套件邊界與三種傳輸方式。
Connect 快速入門第一個可執行的 MCP 握手,以及對應的 REST 渲染請求。
Connect 設定MCP YAML 檔案與 NEXTPDF_* 環境變數。
Connect API 參考每一個已註冊工具、gRPC 符號、錯誤模型條目與速率限制。
Connect 部署RoadRunner worker 設定檔、Docker,以及以 Redis 為後端的儲存層。
Connect 的安全性與維運驗證、傳輸安全性,以及威脅模型。

每一種傳輸方式也都有各自的參考頁面。

頁面用途
MCP 傳輸透過標準輸入與標準輸出的 JSON-RPC 2.0 封裝。
REST 傳輸OpenAPI 3.1 契約、bearer 驗證,以及依層級管控的路由。
gRPC 傳輸nextpdf.connect.v1 服務、伺服器串流,以及 metadata 驗證。

提供 PDF 擷取功能,可由 Python 應用程式、代理與命令列呼叫,並由 NextPDF Connect endpoint 作為後端支援。

頁面用途
Python SDK 套件nextpdf Python 套件的章節中樞頁。
Python SDK 總覽SDK 的功能,以及其與 Connect 的關係。
Python SDK 快速上手pip install nextpdf 安裝,再讓用戶端指向你的伺服器。
Python SDK API 參考資料用戶端類別、方法與具型別結果。
Python CLI 命令列工具用於擷取工作流程的命令列介面。
Python MCP 伺服器讓使用 MCP 的代理存取 SDK。

公開的服務提供者介面(SPI)讓你無須 fork 即可新增能力:它提供字型、版面引擎、事件監聽器與簽章後端的契約,每一項都附有明確的穩定性承諾。

頁面用途
擴充功能開發可擴充的項目,以及背後的穩定性承諾。
SPI 穩定性規則擴充套件可依賴的向後相容契約。
自訂字型:FontRegistry 擴充契約註冊並隨附自有字型。
自訂版面引擎與文字攔截替換或攔截版面行為。
動作觸發器與事件監聽器觀察文件生命週期並做出回應。
KMS 提供者契約從你自己的金鑰管理服務(KMS)提供金鑰。

根據引擎本身的例外分類,提供以症狀為導向的解法條目。請從觀察到的現象開始,而不是先從類別名稱切入。

頁面用途
疑難排解知識庫中樞:條目的組織方式,以及應該從哪裡開始。
疑難排解:字型與標記字型嵌入與結構標記失敗。
疑難排解:加密與權限加密、密碼與權限失敗。
疑難排解:記憶體與效能記憶體上限與吞吐量問題。
疑難排解:PDF/A 與 PDF/UA 驗證封存與無障礙驗證失敗。
疑難排解:簽章與時間戳記簽章與時間戳記驗證失敗。