Руководства
Краткий обзор
Заголовок раздела «Краткий обзор»Руководства связывают NextPDF со средой, в которой выполняется ваш код. Этот раздел начинается с контрольного списка эксплуатации в рабочей среде, а затем охватывает пять областей в рекомендуемом порядке освоения: интеграции с фреймворками и отрисовщиками, сервер NextPDF Connect, Python SDK, разработку расширений движка и устранение неполадок. Каждый раздел ниже начинается с узловой страницы, а затем перечисляет страницы, которые понадобятся чаще всего.
Если вам нужен рецепт для конкретной задачи, который можно сразу скопировать, используйте сборник рецептов. За проверенным описанием API и матрицами поддержки обращайтесь к справочнику.
Интеграции
Заголовок раздела «Интеграции»Восемь пакетов связывают основной движок с фреймворками, браузерными отрисовщиками, периферийными сервисами, инструментами сборки и сценариями миграции с устаревших систем. Раздел каждого пакета построен по единой структуре: обзор, установка, быстрый старт, настройка, API, руководство разработчика, использование в рабочей среде, безопасность и устранение неполадок. Разобравшись с одним, вы сможете ориентироваться в остальных.
| Страница | Назначение |
|---|---|
| Интеграции | Карта расширений и рекомендации по выбору. Прочитайте эту страницу первой, чтобы выбрать пакет. |
| Указатель API для интеграций | Соответствие страниц API расширений конкретным фреймворкам, отрисовщикам, транспортам и интерфейсам инструментов сборки. |
| NextPDF для Laravel | Адаптер фреймворка Laravel. |
| NextPDF для Symfony | Адаптер фреймворка Symfony. |
| NextPDF для CodeIgniter | Адаптер фреймворка CodeIgniter. |
| NextPDF Artisan | Мост к отрисовщику Chrome для браузерной отрисовки HTML. |
| 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, а инструменты высокого риска защищены шлюзом подтверждения с участием человека.
| Страница | Назначение |
|---|---|
| NextPDF Connect | Узловая страница раздела: концепции, настройка и эксплуатация сервера. |
| Обзор Connect | Границы пакета и три транспорта. |
| Быстрый старт Connect | Готовое к запуску первое рукопожатие MCP и соответствующий REST-запрос на отрисовку. |
| Настройка Connect | YAML-файл для MCP и переменные окружения NEXTPDF_*. |
| Справочник по API Connect | Все зарегистрированные инструменты, символы gRPC, записи модели ошибок и ограничения частоты запросов. |
| Развёртывание Connect | Профили воркеров RoadRunner, Docker и хранилище на базе Redis. |
| Безопасность и эксплуатация Connect | Аутентификация, безопасность транспорта и модель угроз. |
Для каждого транспорта есть отдельная справочная страница.
| Страница | Назначение |
|---|---|
| Транспорт MCP | Фрейминг сообщений JSON-RPC 2.0 через стандартный ввод и вывод. |
| Транспорт REST | Контракт OpenAPI 3.1, аутентификация по bearer-токену и маршруты с уровневым ограничением частоты запросов. |
| Транспорт gRPC | Сервис nextpdf.connect.v1, серверный стриминг и аутентификация через метаданные. |
Python SDK
Заголовок раздела «Python SDK»Python SDK извлекает данные из PDF с готовыми цитатами для приложений на Python, агентов и сценариев командной строки через конечную точку NextPDF Connect.
| Страница | Назначение |
|---|---|
| Руководство по Python SDK | Узловая страница раздела для Python-пакета nextpdf. |
| Обзор Python SDK | Что делает SDK и как он связан с Connect. |
| Быстрый старт с Python SDK | Установите пакет с помощью pip install nextpdf и настройте клиент на свой сервер. |
| Справочник по API Python SDK | Классы клиента, методы и типизированные результаты. |
| Python CLI: интерфейс командной строки | Интерфейс командной строки для рабочих процессов извлечения данных. |
| Python MCP-сервер | Как предоставить SDK агентам, работающим по MCP. |
Расширение движка
Заголовок раздела «Расширение движка»Публичный интерфейс поставщика услуг (Service Provider Interface, SPI) позволяет добавлять возможности без форка: контракты для шрифтов, движков макета, обработчиков событий и бэкендов подписания, причём для каждого предусмотрена чёткая гарантия стабильности.
| Страница | Назначение |
|---|---|
| Создание расширений | Что можно расширять и какая гарантия стабильности для этого действует. |
| Правила стабильности SPI | Контракт обратной совместимости, на который может полагаться ваше расширение. |
| Пользовательские шрифты: контракт расширения FontRegistry | Регистрация и поставка собственных шрифтов. |
| Пользовательские движки макета и перехват текста | Замена или перехват поведения макета. |
| Триггеры действий и обработчики событий | Наблюдение за жизненным циклом документа и реакция на события. |
| Контракт поставщика KMS | Предоставление ключей из собственной службы управления ключами (Key Management Service, KMS). |
Устранение неполадок
Заголовок раздела «Устранение неполадок»Записи формата “симптом — решение” основаны на внутренней таксономии исключений движка. Начинайте с наблюдаемого симптома, а не с имени класса.
| Страница | Назначение |
|---|---|
| Устранение неполадок | Узловая страница базы знаний: как устроены записи и с чего начать. |
| Устранение неполадок: шрифты и тегирование | Сбои при внедрении шрифтов и структурном тегировании. |
| Устранение неполадок: шифрование и разрешения | Сбои при работе с шифрованием, паролями и разрешениями. |
| Устранение неполадок: память и производительность | Ограничения памяти и проблемы с пропускной способностью. |
| Устранение неполадок: проверка PDF/A и PDF/UA | Сбои проверки архивной пригодности и доступности. |
| Устранение неполадок: подписи и метки времени | Сбои проверки подписей и меток времени. |
См. также
Заголовок раздела «См. также»- Сборник рецептов — практические рецепты для PHP, Connect и интеграций, готовые к копированию.
- Справочник — проверенное описание API, матрицы поддержки и справочник ошибок.
- Переход на NextPDF — переход с другой библиотеки PDF во вкладке “Начало работы”.
- NextPDF изнутри — эссе Insider_ о том, почему движок ведёт себя именно так.