콘텐츠로 이동

통합 API 색인

통합 유형은 알고 있지만 패키지별 페이지가 무엇인지 모를 때 이 페이지를 사용하십시오. 각 행은 해당 확장 섹션의 정식 API 참조로 연결됩니다.

API 페이지는 소스에 근거하며 동일한 표 형식(기호, 매개변수, 기본 동작, 반환 값, 실패 모드, 운영 참고 사항)을 사용합니다.

표면패키지기본 기호API 페이지
Laravel 파사드 및 컨테이너 바인딩nextpdf/laravelPdf, NextPdfServiceProvider, PdfDocumentInterface, DocumentFactoryInterfaceLaravel API
Laravel HTTP 응답nextpdf/laravelPdfResponse::inline, PdfResponse::download, 스트림 응답 헬퍼Laravel API
Laravel 큐 작업nextpdf/laravelGeneratePdfJob::handle, failed, then, catchLaravel API
Symfony 팩토리 및 번들nextpdf/symfonyPdfFactory, NextPdfBundle, NextPdfExtension, ConfigurationSymfony API
Symfony Messenger 통합nextpdf/symfonyGeneratePdfMessage, PdfBuilderInterface, GeneratePdfHandlerSymfony API
CodeIgniter service/library 통합nextpdf/codeigniterServices, Pdf, pdf(), pdf_document()CodeIgniter API
CodeIgniter 큐 작업nextpdf/codeigniterGeneratePdfJob::process, 정적 빌더 콜러블CodeIgniter API
표면패키지기본 기호API 페이지
호스트 로컬 Chrome 렌더링nextpdf/artisanChromeHtmlRenderer, ChromeRendererConfig, ChromeRenderResult, BrowserPoolArtisan API
Chrome PDF 가져오기nextpdf/artisanPdfReader, PageImporter, ImportedFormXObject, PdfObjectArtisan API
저수준 파서 진단nextpdf/artisanPdfTokenizer, CrossRefParser, RevisionXRefTable, StreamDecoderArtisan API
Cloudflare Browser Rendering 렌더링nextpdf/cloudflareCloudflareHtmlRenderer, CloudflareRendererConfig, CloudflareRenderPayload, CloudflareResponseParserCloudflare API
Cloudflare API 보호nextpdf/cloudflareApiProtection, ApiProtectionConfig, ApiKeyValidator, RateLimitResultCloudflare API
Cloudflare R2 아카이브nextpdf/cloudflareR2ArchiveManager, R2ArchiveConfig, R2ObjectKey, R2UploadResultCloudflare API
Gotenberg 오피스 변환nextpdf/gotenbergGotenbergBridge, GotenbergConfig, GotenbergConvertPayload, GotenbergConvertResultGotenberg API
Gotenberg 형식 및 전송 정책nextpdf/gotenbergOfficeFormat, GotenbergSecurityPolicy, GotenbergResponseParser, PinnedCurlTransportGotenberg API
표면패키지기본 기호API 페이지
TCPDF 어댑터nextpdf/compat-legacyTCPDF, CompatAdapterInterface, LegacyBootstrap, AdaptationConfigTCPDF 호환성 API
TCPDF 메서드 계열nextpdf/compat-legacy텍스트, 글꼴, 페이지, 이미지, 그리기, 보안, 양식, 출력 관련 항목TCPDF 메서드 커버리지
백포트 빌드 스크립트nextpdf/backport-builderBuild, MergeSources, AdjustComposer, ValidateBuildContractBackport Builder API 페이지
백포트 Rector 규칙nextpdf/backport-builderDowngradeAsymmetricVisibilityRector, DowngradeCloneWithRector, DowngradeTraitConstantsRectorBackport 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 운영 페이지.
오피스 문서 변환GotenbergBridge::convertFile() 또는 convertString().Gotenberg 구성 및 문제 해결 페이지.
생성된 PDF를 객체 스토리지에 아카이브R2ArchiveManager::upload()generateSignedUrl().Cloudflare 프로덕션 사용 및 보안 페이지.
TCPDF 코드베이스 마이그레이션TCPDF, 메서드 커버리지, OutputBridge.TCPDF 호환성 마이그레이션 가이드.
이전 런타임 패키지 빌드scripts/build.phpBuild::run().백포트 개발자 가이드 및 프로덕션 사용 페이지.
작업구성 영역패키지 페이지
문서 메타데이터 기본값 설정defaults.*Laravel, Symfony 또는 CodeIgniter 구성 페이지.
프로덕션 글꼴 예열preload_fonts 또는 preloadFonts프레임워크 구성 페이지.
Chrome 바이너리 및 타임아웃 구성artisan.* 또는 ChromeRendererConfigArtisan 및 프레임워크 구성 페이지.
서명 및 TSA 구성signature.*, tsa.*, ocsp_cache.*프레임워크 구성 페이지.
공개 렌더 엔드포인트 보호ApiProtectionConfigCloudflare API 및 보안 페이지.
R2 아카이브 구성R2ArchiveConfigCloudflare 구성 및 API 페이지.
Gotenberg 서비스 구성GotenbergConfigGotenberg 구성 및 API 페이지.
호환성 동작 조정AdaptationConfigTCPDF 호환성 구성 페이지.
증상예상되는 API 경계첫 번째 진단 페이지
응답이 잘못된 파일 이름으로 다운로드됨프레임워크 PdfResponse 헬퍼.해당 프레임워크 API 페이지.
큐 작업이 렌더링 전에 실패함작업/메시지 검증.해당 프레임워크 문제 해결 페이지.
Chrome 렌더가 시간 초과됨ChromeHtmlRenderer 또는 BrowserPool.Artisan 문제 해결 페이지.
워커가 PDF가 아닌 데이터를 반환함CloudflareResponseParser.Cloudflare 문제 해결 페이지.
R2 업로드는 성공하지만 URL을 사용할 수 없음R2UploadResult 또는 서명된 URL 생성.Cloudflare 프로덕션 사용 페이지.
오피스 파일이 거부됨OfficeFormat 또는 GotenbergSecurityPolicy.Gotenberg 문제 해결 페이지.
레거시 TCPDF 메서드가 예외를 발생시킴호환성 관련 항목 또는 예외 팩토리.TCPDF 메서드 커버리지 페이지.
백포트 출력이 구문 검사에 실패함Rector 구성 또는 사용자 지정 규칙.백포트 개발자 가이드.

각 패키지 API 페이지는 다음을 문서화해야 합니다:

필수 세부 정보이유
완전히 정규화된 기호독자가 네임스페이스를 추측하지 않고 소스와 테스트를 검색할 수 있도록 합니다.
매개변수 이름 및 기본값호출 지점의 모호함을 방지하고 형식이 지정된 예제를 지원합니다.
기본 동작선택적 입력을 의도적으로 생략해도 안전하도록 합니다.
반환 값 또는 부작용메서드가 유연한지, 종단인지, 진단용인지 보여 줍니다.
실패 모드프로덕션 코드가 실패 시 닫힌 상태로 동작하고 올바른 경계를 기록하도록 돕습니다.
운영 참고 사항워커 안전성, 보안, 메모리, 타임아웃 또는 호환성 관련 사항을 기록합니다.