ガイド
このガイドでは、コードを実行する環境と NextPDF をどのようにつなぐかを説明します。このタブでは、まず 本番運用チェックリスト から始め、続いて導入の流れに沿って 5 つの領域、つまりフレームワークとレンダラーの統合、NextPDF Connect サーバー、Python SDK、エンジン拡張機能の作成、そしてトラブルシューティングを扱います。各セクションでは、最初にハブページを示し、続いてよく使われるページを一覧します。
タスク別にそのままコピーして使えるレシピが必要な場合は、クックブック を参照してください。検証済みの Application Programming Interface (API) サーフェスとサポートマトリックスを確認する場合は、リファレンス を参照してください。
8 つのパッケージは、コアエンジンをフレームワーク、ブラウザーレンダラー、エッジサービス、ビルドツール、レガシー移行パスにつなぎます。各パッケージのセクションは、概要、インストール、クイックスタート、構成、API、開発者ガイド、本番運用、セキュリティ、トラブルシューティングという共通のマニュアル構成に従っています。そのため、1 つの構成を理解しておけば、他のセクションも同じ流れで読み進められます。
| ページ | 用途 |
|---|---|
| 統合 | 拡張機能マップと選択ガイドです。パッケージを選ぶ起点として、まず確認してください。 |
| 統合 API インデックス | 各フレームワーク、レンダラー、トランスポート、ビルドツールのサーフェスをどの拡張 API ページで扱うかを示します。 |
| Laravel 向け NextPDF | Laravel 向けのフレームワークアダプターです。 |
| Symfony 向け NextPDF | Symfony 向けのフレームワークアダプターです。 |
| CodeIgniter 向け NextPDF | CodeIgniter 向けのフレームワークアダプターです。 |
| NextPDF Artisan | ブラウザー品質の HTML レンダリングに使用する Chrome レンダラーブリッジです。 |
| NextPDF Cloudflare | Cloudflare 上にデプロイするためのエッジデプロイパスです。 |
| NextPDF Gotenberg | Gotenberg レンダラーブリッジです。 |
| TCPDF 互換 | TCPDF から移行するコードベース向けの互換シムです。 |
| NextPDF Backport Builder | 古い PHP ランタイムを対象とするビルドツールです。 |
NextPDF Connect
「NextPDF Connect」という見出しのセクションnextpdf/server パッケージは、長時間稼働するサービスとしてエンジンを実行します。Model Context Protocol (MCP)、Representational State Transfer (REST)、および gRPC 経由で提供される単一の決定論的なツールレジストリであり、高リスクのツールは human-in-the-loop の確認ゲートを通過したうえで実行されます。
| ページ | 用途 |
|---|---|
| NextPDF Connect | このセクションのハブです。サーバーの概念、構成、運用を扱います。 |
| NextPDF Connect 概要 | パッケージの境界と 3 つのトランスポートを説明します。 |
| NextPDF Connect クイックスタート | 最初に実行できる MCP ハンドシェイクと、対応する REST レンダリングリクエストを示します。 |
| Connect の構成 | MCP の YAML ファイルと NEXTPDF_* 環境変数を説明します。 |
| Connect API リファレンス | 登録済みツール、gRPC シンボル、エラーモデルの項目、レート制限を網羅します。 |
| Connect のデプロイ | RoadRunner のワーカープロファイル、Docker、Redis を基盤とするストアを扱います。 |
| NextPDF Connect のセキュリティと運用 | 認証、トランスポートセキュリティ、脅威モデルを扱います。 |
各トランスポートには専用のリファレンスページがあります。
| ページ | 用途 |
|---|---|
| MCP トランスポート | 標準入力と標準出力を介した JSON-RPC 2.0 フレーミングを説明します。 |
| REST トランスポート | OpenAPI 3.1 コントラクト、ベアラー認証、ティア別にゲートされるルートを扱います。 |
| gRPC トランスポート | nextpdf.connect.v1 サービス、サーバーストリーミング、メタデータ認証を扱います。 |
Python SDK
「Python SDK」という見出しのセクションPython アプリケーション、エージェント、コマンドライン向けに、引用可能な PDF 抽出機能を提供します。NextPDF Connect エンドポイントを基盤としています。
| ページ | 用途 |
|---|---|
| Python SDK ガイド | nextpdf Python パッケージのセクションハブです。 |
| Python SDK の概要 | SDK の役割と Connect との関係を説明します。 |
| Python SDK クイックスタート | pip install nextpdf でインストールし、クライアントの接続先をサーバーに設定します。 |
| Python SDK API リファレンス | クライアントクラス、メソッド、型付き結果を扱います。 |
| Python CLI（コマンドラインインターフェイス） | 抽出ワークフロー向けのコマンドラインインターフェイスです。 |
| Python MCP サーバー | MCP で通信するエージェントに SDK を公開します。 |
エンジンの拡張
「エンジンの拡張」という見出しのセクション公開された Service Provider Interface (SPI) を使うと、フォークすることなく機能を追加できます。フォント、レイアウトエンジン、イベントリスナー、署名バックエンド向けのコントラクトが用意されており、それぞれに明示的な安定性の保証が定義されています。
| ページ | 用途 |
|---|---|
| 拡張機能の作成 | 拡張できる対象と、それを支える安定性の保証を説明します。 |
| SPI の安定性ルール | 拡張機能が依拠できる後方互換性コントラクトを説明します。 |
| カスタムフォント: FontRegistry コントラクト | 独自のフォントを登録し、同梱します。 |
| カスタムレイアウトエンジンとテキストのインターセプト | レイアウト動作を置き換えたり、インターセプトしたりします。 |
| アクショントリガーとイベントリスナー | ドキュメントのライフサイクルを観測して反応します。 |
| KMS プロバイダーコントラクト | 独自の Key Management Service (KMS) から鍵を提供します。 |
トラブルシューティング
「トラブルシューティング」という見出しのセクションエンジン自体の例外分類体系に基づき、症状から解決策へ進めるセクションです。クラス名ではなく、観測した事象から始めてください。
| ページ | 用途 |
|---|---|
| トラブルシューティング | ナレッジベースのハブです。項目の構成と、どこから始めればよいかを説明します。 |
| フォントとタグ付けのトラブルシューティング | フォントの埋め込みと構造タグ付けの失敗を扱います。 |
| トラブルシューティング：暗号化と権限 | 暗号化、パスワード、権限の失敗を扱います。 |
| トラブルシューティング：メモリとパフォーマンス | メモリ上限とスループットの問題を扱います。 |
| トラブルシューティング：PDF/A および PDF/UA の検証 | アーカイブおよびアクセシビリティ検証の失敗を扱います。 |
| トラブルシューティング：署名とタイムスタンプ | 署名とタイムスタンプの検証失敗を扱います。 |
- クックブック — PHP、Connect、各種統合で使えるタスク別レシピです。
- リファレンス — 検証済みの API サーフェス、サポートマトリックス、エラーリファレンスをまとめています。
- NextPDF への移行 — 別の PDF ライブラリから移行するためのガイドです。「はじめに」タブにあります。
- NextPDF の内部 — エンジンがそのように動作する理由を扱う Insider_ エッセイです。