跳转到内容
getnextpdf.com

参考文档

参考文档用于回答精确问题:该调用哪个符号、该使用哪个取值、支持程度如何、对应哪条条款。此标签页汇总 NextPDF 已核验的对外接口范围:模块参考、支持矩阵、API 接口、错误参考、标准一致性,以及项目公开发布的各项政策。这里不讲解如何完成某个目标;如需这类内容,请参阅指南Cookbook(示例指南)

按模块组织 nextpdf/core 引擎参考。

页面用途
核心引擎参考命名空间导览:各模块页面及四个子族。
契约:41 个公开接口(SPI)纳入稳定性跟踪的公开接口和枚举。
Core:Document 门面与职责 traitDocument 门面及 Has* trait 家族。
HTML:HTML+CSS 转 PDF 渲染子系统单遍流式 HTML 渲染器。
安全性:加密、加密策略与签名接口加密、权限与签名集成点。

说明渲染器对各类内容的支持状态:已验证支持、已声明支持、部分支持或不支持。

页面用途
CSS 支持矩阵HTML 管道中各项层叠样式表(CSS)特性的支持级别。
不支持的 CSS 特性与变通方案哪些特性超出支持范围,以及可替代的方案。
字体与文字系统支持矩阵字体技术与书写系统的支持情况。
CJK 竖排书写支持面向中文、日文和韩文文本的竖排书写模式支持情况。
复杂文字塑形支持面向需要文字塑形的书写系统的支持情况。

准确列出符号、允许取值与服务契约。

页面用途
Enum 参考每个公共枚举及其允许取值。
TSA 配置默认时间戳机构(TSA)及其更改方式。
Connect REST API 参考NextPDF Connect 的 REST 端点,基于 OpenAPI 3.1 文档。
Connect API 浏览器基于同一契约的交互式浏览器。

包级 API 参考随对应包提供:指南标签页中的 NextPDF Connect API 参考文档集成 API 索引Python SDK API 参考

引擎抛出的每个异常都按领域组织,并附带结构化上下文与恢复指引。

页面用途
错误参考异常模型:NextPdfException 基类及上下文契约。
核心与通用错误文档生命周期与通用引擎故障。
渲染与 I/O 错误HTML、字体、写入器与读取器故障。
安全与签名错误加密、签名与 PKI 故障。
运行时与支持错误HTTP、弹性与可观测性故障。
Accelerator 错误可选加速 sidecar 相关故障。
合规错误验证和一致性工具故障。

本节列出 NextPDF Core 面向的各项标准配置文件,并明确各项边界:引擎的目标是生成符合标准的输出;是否一致由外部验证器判定。

页面用途
标准一致性一致性立场与配置文件索引。
PDF 2.0 一致性引擎面向的 ISO 32000-2 基准。
PDF/A-4 一致性归档一致性,并附带 PDF/A-4 条款映射
PDF/UA-2 一致性无障碍一致性,并附带 PDF/UA-2 条款映射
PDF/X 一致性印刷生产一致性。
PAdES 条款映射面向 PDF 签名的 ETSI EN 319 142 基准配置文件映射。
ZUGFeRD / Factur-X 一致性混合电子发票一致性。

说明核心引擎的工程立场,并明确每项声明的适用边界。

页面用途
信任中心工程立场索引。
产品许可开放内核与商业版的许可条款。
商标与品牌使用NextPDF 名称与标识的使用方式。
数据处理、PII 与遥测引擎会读取、存储、传输哪些内容。
签名与加密安全模型密码学设计及其限制。
引擎威胁模型引擎防御什么,以及不防御什么。
漏洞披露政策漏洞报告方式。
页面用途
更新日志各版本包含的变更。
更新日志约定更新日志条目如何撰写与分类。
版本管理、稳定性、弃用与支持策略跨版本的兼容性承诺。
NextPDF 文档组织结构本文档集的结构与治理。

术语表 —— 本文档集使用的术语在此统一定义,并在文档各处提供链接。

每个 API 条目都必须回答同一组问题:

问题必需的答复
我该调用什么?完全限定符号、端点、命令行接口(CLI)命令或配置键。
接受什么输入?参数表,包含类型、是否必需、默认值和可接受值。
默认情况下会发生什么?省略可选输入时的具体行为。
会返回什么?返回类型、响应体、文件输出、流或副作用。
什么会出错?异常、验证错误、HTTP 状态或运行时故障模式。
我该如何安全地使用它?安全性、worker 安全、大小限制、路径、超时和密钥处理说明。

API 与行为参考页面均以源码为依据。公共 API 文档根据包源码、配置文件、测试和示例编写。只有当应用开发者必须了解内部辅助类的行为,才能配置或操作该包时,才会为这些内部辅助类编写文档。

参考页面优先使用表格,避免段落过于密集。每一行都应可独立理解,因为后续生成 XLIFF(可扩展本地化交换文件格式)分段时会按块拆分内容。