当你知道集成类型，但不确定具体的软件包页面时，可使用本页。每一行都链接到对应扩展部分的权威 API 参考。
这些 API 页面均以源码为依据，并采用一致的表格结构：符号、参数、默认行为、返回值、失败模式和操作说明。
| 接口范围 | 软件包 | 主要符号 | API 页面 |
|---|
| Laravel 外观与容器绑定 | nextpdf/laravel | Pdf、 NextPdfServiceProvider、 PdfDocumentInterface、 DocumentFactoryInterface | Laravel API |
| Laravel HTTP 响应 | nextpdf/laravel | PdfResponse::inline、 PdfResponse::download、流式响应辅助函数 | Laravel API |
| Laravel 队列任务 | nextpdf/laravel | GeneratePdfJob::handle、 failed、 then、 catch | Laravel API |
| Symfony 工厂与 bundle | nextpdf/symfony | PdfFactory、 NextPdfBundle、 NextPdfExtension、 Configuration | Symfony API |
| Symfony Messenger | nextpdf/symfony | GeneratePdfMessage、 PdfBuilderInterface、 GeneratePdfHandler | Symfony API |
| CodeIgniter service/library | nextpdf/codeigniter | Services、 Pdf、 pdf()、 pdf_document() | CodeIgniter API |
| CodeIgniter 队列任务 | nextpdf/codeigniter | GeneratePdfJob::process、静态构建器可调用对象 | CodeIgniter API |
| 接口范围 | 软件包 | 主要符号 | API 页面 |
|---|
| 宿主机本地 Chrome 渲染 | nextpdf/artisan | ChromeHtmlRenderer、 ChromeRendererConfig、 ChromeRenderResult、 BrowserPool | Artisan API |
| Chrome PDF 导入 | nextpdf/artisan | PdfReader、 PageImporter、 ImportedFormXObject、 PdfObject | Artisan API |
| 底层解析器诊断 | nextpdf/artisan | PdfTokenizer、 CrossRefParser、 RevisionXRefTable、 StreamDecoder | Artisan API |
| Cloudflare 浏览器渲染 | nextpdf/cloudflare | CloudflareHtmlRenderer、 CloudflareRendererConfig、 CloudflareRenderPayload、 CloudflareResponseParser | Cloudflare API |
| Cloudflare API 防护 | nextpdf/cloudflare | ApiProtection、 ApiProtectionConfig、 ApiKeyValidator、 RateLimitResult | Cloudflare API |
| Cloudflare R2 归档 | nextpdf/cloudflare | R2ArchiveManager、 R2ArchiveConfig、 R2ObjectKey、 R2UploadResult | Cloudflare API |
| Gotenberg Office 转换 | nextpdf/gotenberg | GotenbergBridge、 GotenbergConfig、 GotenbergConvertPayload、 GotenbergConvertResult | Gotenberg API |
| Gotenberg 格式与传输策略 | nextpdf/gotenberg | OfficeFormat、 GotenbergSecurityPolicy、 GotenbergResponseParser、 PinnedCurlTransport | Gotenberg API |
| 接口范围 | 软件包 | 主要符号 | API 页面 |
|---|
| TCPDF 适配器 | nextpdf/compat-legacy | TCPDF、 CompatAdapterInterface、 LegacyBootstrap、 AdaptationConfig | TCPDF 兼容 API |
| TCPDF 方法族 | nextpdf/compat-legacy | 文本、字体、页面、图像、绘制、安全、表单和输出相关功能 | TCPDF 方法覆盖 |
| Backport 构建脚本 | nextpdf/backport-builder | Build、 MergeSources、 AdjustComposer、 ValidateBuildContract | Backport Builder API |
| Backport Rector 规则 | nextpdf/backport-builder | DowngradeAsymmetricVisibilityRector、 DowngradeCloneWithRector、 DowngradeTraitConstantsRector | Backport Builder API |
| 任务 | 从这里开始 | 然后阅读 |
|---|
| 从框架控制器返回 PDF | PdfResponse 位于对应的框架软件包中。 | 先读软件包的 quickstart，再读其 api 响应表。 |
| 在后台工作进程中生成 PDF | Laravel GeneratePdfJob、Symfony GeneratePdfMessage，或 CodeIgniter GeneratePdfJob。 | 软件包 developer-guide 中的队列或 Messenger 模式。 |
| 使用宿主机本地 Chrome 渲染 HTML | ChromeHtmlRenderer::render()。 | Artisan 的配置、安全和生产使用页面。 |
| 通过 Cloudflare 渲染 HTML | CloudflareHtmlRenderer::render()。 | Cloudflare API 防护与 Worker 运维页面。 |
| 转换 Office 文档 | GotenbergBridge::convertFile() 或 convertString()。 | Gotenberg 配置和故障排查页面。 |
| 将生成的 PDF 归档到对象存储 | R2ArchiveManager::upload() 和 generateSignedUrl()。 | Cloudflare 的生产使用和安全页面。 |
| 迁移 TCPDF 代码库 | TCPDF、方法覆盖，以及 OutputBridge。 | TCPDF 兼容迁移指南。 |
| 构建面向旧运行时的软件包 | scripts/build.php 和 Build::run()。 | Backport 开发者指南与生产使用页面。 |
| 任务 | 配置区域 | 软件包页面 |
|---|
| 设置文档元数据默认值 | defaults.* | Laravel、Symfony 或 CodeIgniter 的配置页面。 |
| 预热生产环境字体 | preload_fonts 或 preloadFonts | 框架配置页面。 |
| 配置 Chrome 二进制文件和超时 | artisan.* 或 ChromeRendererConfig | Artisan 与框架配置页面。 |
| 配置签名与 TSA | signature.*、 tsa.*、 ocsp_cache.* | 框架配置页面。 |
| 保护公开渲染端点 | ApiProtectionConfig | Cloudflare API 和安全页面。 |
| 配置 R2 归档 | R2ArchiveConfig | Cloudflare 配置和 API 页面。 |
| 配置 Gotenberg 服务 | GotenbergConfig | Gotenberg 配置和 API 页面。 |
| 调整兼容行为 | AdaptationConfig | TCPDF 兼容配置页面。 |
| 症状 | 可能的 API 边界 | 首选诊断页面 |
|---|
| 下载响应的文件名错误 | 框架中的 PdfResponse 辅助函数。 | 对应的框架 API 页面。 |
| 队列任务在渲染前失败 | 任务/消息校验。 | 对应的框架故障排查页面。 |
| Chrome 渲染超时 | ChromeHtmlRenderer 或 BrowserPool。 | Artisan 故障排查页面。 |
| Worker 返回非 PDF 数据 | CloudflareResponseParser。 | Cloudflare 故障排查页面。 |
| R2 上传成功但 URL 不可用 | R2UploadResult 或签名 URL 生成。 | Cloudflare 生产使用页面。 |
| Office 文件被拒绝 | OfficeFormat 或 GotenbergSecurityPolicy。 | Gotenberg 故障排查页面。 |
| 旧版 TCPDF 方法抛出异常 | 兼容功能或异常工厂。 | TCPDF 方法覆盖页面。 |
| Backport 输出未通过语法检查 | Rector 配置或自定义规则。 | Backport 开发者指南。 |
每个软件包的 API 页面都应记录以下内容：
| 必备细节 | 原因 |
|---|
| 完全限定的符号 | 让读者无需猜测命名空间，就能搜索源码和测试。 |
| 参数名称和默认值 | 避免调用点产生歧义，并支持带类型的示例。 |
| 默认行为 | 让可选输入在被有意省略时仍能保持安全。 |
| 返回值或副作用 | 表明该方法是链式调用、终结操作还是诊断性方法。 |
| 失败模式 | 帮助生产代码按失败关闭方式处理错误，并记录正确的边界。 |
| 操作说明 | 涵盖工作进程安全、安全控制、内存、超时或兼容性方面的注意事项。 |
