Documentize.Plugins для разработчиков
Кратко
CLI-инструменты, с которыми вы познакомились в разделе CLI-плагины, построены на небольшом общем контракте плагинов. Разработчики, которые хотят запускать эти плагины из собственного ПО или понять, как платформа ими управляет, работают с проектом Documentize.Plugins (products.documentize.com). Эта страница описывает контракт так, как он виден пользователю загрузок; авторитетна документация для разработчиков на том сайте.
Контракт простыми словами
- Плагин — это программа со стабильной точкой входа и именованным набором параметров (например,
--angle,--remove-range), у каждого из которых есть значение по умолчанию. - Он читает входные файлы из
<PLUGIN_INPUT_DIR>/<task-id>/и записывает результаты в<PLUGIN_OUTPUT_DIR>/<task-id>/. - Всё, что нужно задаче, можно вместо этого передать одним аргументом — JSON в кодировке base64; имена полей — это имена параметров в PascalCase плюс
IDдля идентификатора задачи. - Он сообщает о состоянии через код завершения (0 — успех, 1 — задача не выполнена, 2 — неверные аргументы) и записывает служебный файл
<task-id>.jsonдля Plugin Manager. - Он работает со средой выполнения .NET 10 и, для движка документов, с лицензией
documentize.licрядом со сборкой.
Plugin Manager в платформе — это программа, которая именно так запускает плагины для облачных задач. Ручной запуск плагина, как в главе о CLI, — тот же вызов без менеджера.
Встраивание в собственный код
Управлять плагинами можно из любого языка, который умеет запускать процесс, задавать две переменные окружения и читать коды завершения:
PLUGIN_INPUT_DIR=/srv/in PLUGIN_OUTPUT_DIR=/srv/out \
dotnet Documentize.Compress.dll --task-id "$ID" --compress-type 1
Создавайте входную папку для каждой задачи, копируйте в неё файлы, запускайте и читайте выходную папку. Для .NET-кода есть Aspose.PDF.FOSS на NuGet — отдельная библиотека с открытым исходным кодом, на которую ссылаются практические руководства; она предназначена для тех же задач, но в коде.
Свой собственный плагин
Каталог принимает заявки; на странице каталога упомянута форма «Submit Plugin». В репозитории есть проект контрактных тестов (Documentize.Plugin.Contracts.Tests), который следит, чтобы плагины соблюдали этот контракт, но его содержимое внутреннее. За SDK, шаблонами и правилами отправки обращайтесь на сайт для разработчиков (проверьте).