Documentize.Plugins para desarrolladores
En resumen
Las herramientas de CLI que conociste en Plugins de CLI se construyen sobre un pequeño contrato de plugins compartido. Los desarrolladores que quieran ejecutar esos plugins desde su propio software, o entender cómo los planifica la plataforma, trabajan con el proyecto Documentize.Plugins (products.documentize.com). Esta página describe el contrato tal como lo ve quien usa las descargas; la documentación para desarrolladores de ese sitio es la autoridad.
El contrato, en palabras llanas
- Un plugin es un programa con un punto de entrada estable y un conjunto de opciones con nombre (por ejemplo
--angle,--remove-range), todas con valores predeterminados. - Lee los archivos de entrada de
<PLUGIN_INPUT_DIR>/<task-id>/y escribe los resultados en<PLUGIN_OUTPUT_DIR>/<task-id>/. - Todo lo que una tarea necesita puede enviarse, en cambio, como un único argumento JSON codificado en base64; los nombres de campo son los nombres de las opciones en PascalCase más
IDpara el id de tarea. - Informa de su estado mediante su código de salida (0 correcto, 1 la tarea falló, 2 argumentos incorrectos) y escribe un archivo de traspaso
<task-id>.jsonpara el Plugin Manager. - Se ejecuta con el entorno de ejecución .NET 10 y, para el motor de documentos, una licencia
documentize.licjunto al ensamblado.
El Plugin Manager de la plataforma es el programa que lanza los plugins de este modo para las tareas en la nube. Ejecutar un plugin a mano, como en el capítulo de CLI, es la misma llamada sin el gestor.
Integrarlo en tu propio código
Puedes manejar los plugins desde cualquier lenguaje capaz de iniciar un proceso, definir dos variables de entorno y leer códigos de salida:
PLUGIN_INPUT_DIR=/srv/in PLUGIN_OUTPUT_DIR=/srv/out \
dotnet Documentize.Compress.dll --task-id "$ID" --compress-type 1
Crea la carpeta de entrada para cada tarea, copia dentro los archivos, ejecuta y lee la carpeta de salida. Para código .NET, Aspose.PDF.FOSS en NuGet es una biblioteca de código abierto independiente, enlazada desde las guías prácticas, pensada para el mismo tipo de trabajos en código.
Escribir tu propio plugin
El catálogo admite aportaciones; la página del catálogo menciona un formulario «Submit Plugin» (enviar plugin). En el repositorio existe un proyecto de pruebas del contrato (Documentize.Plugin.Contracts.Tests) para que los plugins respeten este contrato, pero su contenido es interno. Para el SDK, las plantillas y las reglas de envío, usa el sitio para desarrolladores (compruébalo en la aplicación en funcionamiento).