Chỉ mục API cho tích hợp

Tổng quan nhanh

Dùng trang này khi bạn đã biết loại tích hợp nhưng cần tài liệu tham khảo riêng của từng gói khi làm việc với Portable Document Format (PDF). Mỗi hàng liên kết đến trang giao diện lập trình ứng dụng (API) chính thức cho khu vực mở rộng tương ứng.

Các trang API được xây dựng từ mã nguồn và dùng chung một định dạng bảng: ký hiệu, tham số, hành vi mặc định, giá trị trả về, chế độ lỗi và ghi chú vận hành.

API framework

Bề mặt	Gói	Ký hiệu chính	Trang API
Facade và container binding trong Laravel	nextpdf/laravel	Pdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterface	Laravel API
Phản hồi Hypertext Transfer Protocol (HTTP) của Laravel	nextpdf/laravel	PdfResponse::inline, PdfResponse::download, các helper phản hồi luồng	Laravel API
Job trong hàng đợi của Laravel	nextpdf/laravel	GeneratePdfJob::handle, failed, then, catch	Laravel API
Factory và bundle trong Symfony	nextpdf/symfony	PdfFactory, NextPdfBundle, NextPdfExtension, Configuration	Symfony API
Symfony Messenger	nextpdf/symfony	GeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandler	Symfony API
Service và library trong CodeIgniter	nextpdf/codeigniter	Services, Pdf, pdf(), pdf_document()	CodeIgniter API
Job trong hàng đợi của CodeIgniter	nextpdf/codeigniter	GeneratePdfJob::process, callable builder tĩnh	CodeIgniter API

API kết xuất và chuyển đổi

Bề mặt	Gói	Ký hiệu chính	Trang API
Kết xuất bằng Chrome trên máy chủ	nextpdf/artisan	ChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPool	Artisan API
Nhập PDF bằng Chrome	nextpdf/artisan	PdfReader, PageImporter, ImportedFormXObject, PdfObject	Artisan API
Chẩn đoán parser cấp thấp	nextpdf/artisan	PdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoder	Artisan API
Cloudflare Browser Rendering	nextpdf/cloudflare	CloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParser	Cloudflare API
Bảo vệ API của Cloudflare	nextpdf/cloudflare	ApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResult	Cloudflare API
Lưu trữ trên Cloudflare R2	nextpdf/cloudflare	R2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResult	Cloudflare API
Chuyển đổi tài liệu văn phòng bằng Gotenberg	nextpdf/gotenberg	GotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResult	Gotenberg API
Chính sách định dạng và vận chuyển của Gotenberg	nextpdf/gotenberg	OfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransport	Gotenberg API

API di chuyển và build

Bề mặt	Gói	Ký hiệu chính	Trang API
Bộ chuyển đổi TCPDF	nextpdf/compat-legacy	TCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfig	TCPDF compatibility API
Các họ phương thức TCPDF	nextpdf/compat-legacy	Các phần liên quan đến văn bản, phông chữ, trang, hình ảnh, vẽ, bảo mật, biểu mẫu và đầu ra	TCPDF method coverage
Script build cho backport	nextpdf/backport-builder	Build, MergeSources, AdjustComposer, ValidateBuildContract	Backport Builder API
Quy tắc Rector cho backport	nextpdf/backport-builder	DowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRector	Backport Builder API

API theo tác vụ

Tác vụ	Bắt đầu với	Sau đó đọc
Trả về PDF từ controller của framework	PdfResponse trong gói framework tương ứng.	Trang quickstart của gói, rồi đến bảng phản hồi api.
Tạo tệp PDF trong worker nền	Laravel GeneratePdfJob, Symfony GeneratePdfMessage, hoặc CodeIgniter GeneratePdfJob.	Mẫu hàng đợi hoặc Messenger trong developer-guide của gói.
Kết xuất Hypertext Markup Language (HTML) bằng Chrome trên máy chủ	ChromeHtmlRenderer::render().	Các trang cấu hình, bảo mật và cách dùng trong môi trường production của Artisan.
Kết xuất HTML qua Cloudflare	CloudflareHtmlRenderer::render().	Các trang bảo vệ API và vận hành Worker của Cloudflare.
Chuyển đổi tài liệu văn phòng	GotenbergBridge::convertFile() hoặc convertString().	Các trang cấu hình và khắc phục sự cố của Gotenberg.
Lưu trữ các PDF đã tạo vào kho lưu trữ đối tượng	R2ArchiveManager::upload() và generateSignedUrl().	Các trang sử dụng trong môi trường production và bảo mật của Cloudflare.
Di chuyển một codebase TCPDF	TCPDF, phạm vi phương thức, và OutputBridge.	Hướng dẫn di chuyển tương thích với TCPDF.
Build các gói cho runtime cũ hơn	scripts/build.php và Build::run().	Hướng dẫn dành cho nhà phát triển và các trang sử dụng trong môi trường production của Backport.

Cấu hình theo tác vụ

Tác vụ	Khu vực cấu hình	Trang của gói
Đặt giá trị mặc định cho metadata tài liệu	defaults.*	Cấu hình của Laravel, Symfony hoặc CodeIgniter.
Tải trước phông chữ cho production	preload_fonts hoặc preloadFonts	Các trang cấu hình framework.
Cấu hình tệp nhị phân Chrome và thời gian chờ	artisan.* hoặc ChromeRendererConfig	Các trang cấu hình của Artisan và framework.
Cấu hình ký và Time-Stamping Authority (TSA)	signature.*, tsa.*, ocsp_cache.*	Các trang cấu hình framework.
Bảo vệ các endpoint kết xuất công khai	ApiProtectionConfig	Các trang API và bảo mật của Cloudflare.
Cấu hình kho lưu trữ R2	R2ArchiveConfig	Các trang cấu hình và API của Cloudflare.
Cấu hình service Gotenberg	GotenbergConfig	Các trang cấu hình và API của Gotenberg.
Tinh chỉnh hành vi tương thích	AdaptationConfig	Trang cấu hình tương thích TCPDF.

Chỉ mục chế độ lỗi

Triệu chứng	Ranh giới API có khả năng	Trang chẩn đoán đầu tiên
Phản hồi tải xuống với tên tệp sai	Helper PdfResponse của framework.	Trang API của framework tương ứng.
Job hàng đợi lỗi trước khi kết xuất	Kiểm tra tính hợp lệ của job/message.	Trang khắc phục sự cố của framework tương ứng.
Kết xuất Chrome hết thời gian chờ	ChromeHtmlRenderer hoặc BrowserPool.	Trang khắc phục sự cố của Artisan.
Worker trả về dữ liệu không phải đầu ra PDF	CloudflareResponseParser.	Trang khắc phục sự cố của Cloudflare.
Tải lên R2 thành công, nhưng Uniform Resource Locator (URL) không dùng được	R2UploadResult hoặc bước tạo URL đã ký.	Trang sử dụng trong môi trường production của Cloudflare.
Tệp văn phòng bị từ chối	OfficeFormat hoặc GotenbergSecurityPolicy.	Trang khắc phục sự cố của Gotenberg.
Phương thức TCPDF cũ ném ngoại lệ	Vấn đề tương thích hoặc factory ngoại lệ.	Trang phạm vi phương thức TCPDF.
Đầu ra backport không vượt qua kiểm tra cú pháp	Cấu hình Rector hoặc quy tắc tùy chỉnh.	Hướng dẫn dành cho nhà phát triển của Backport.

Hợp đồng mục nhập

Mỗi trang API của gói cần ghi lại:

Chi tiết bắt buộc	Lý do
Ký hiệu đầy đủ định danh	Giúp bạn tìm trong mã nguồn và bài kiểm thử mà không phải đoán namespace.
Tên tham số và giá trị mặc định	Tránh mơ hồ tại điểm gọi và hỗ trợ các ví dụ có kiểu rõ ràng.
Hành vi mặc định	Giúp việc chủ động bỏ qua đầu vào tùy chọn trở nên an toàn.
Giá trị trả về hoặc tác động phụ	Cho biết phương thức là fluent, kết thúc hay chẩn đoán.
Chế độ lỗi	Giúp mã production fail closed và ghi log đúng ranh giới.
Ghi chú vận hành	Ghi lại các vấn đề về an toàn worker, bảo mật, bộ nhớ, thời gian chờ hoặc khả năng tương thích.