5.6. Parametrización API REST plugins externos

Plugins Externos por API REST

Descripción General

El sistema API-IDEE permite cargar plugins externos de forma dinámica a través de la API REST. Estos plugins no están incluidos en el servidor local, sino que se cargan desde un repositorio remoto (Community Plugins).

• URL repositorio Community Plugins: https://github.com/Desarrollos-IDEE/API-IDEE_CommunityPlugins
• URL despliegue: https://componentes.idee.es/api-idee-communityplugins/gallery/

Los plugins externos se gestionan de forma transparente para el usuario, de manera que pueden utilizarse de la misma forma que los plugins internos a través de los parámetros de la URL.

Configuración

URL Base de Plugins Externos

La URL base donde se alojan los plugins externos se configura en el archivo de propiedades:

# Archivo: api-idee-rest/src/main/resources/properties/configuration.properties
plugins.external.base.url=${plugins.external.base.url}

El valor real se define en los archivos de filtros de Maven según el entorno:

# Archivo: api-idee-parent/src/main/filters/local.properties
# Archivo: api-idee-parent/src/main/filters/cnig-desarrollo.properties
plugins.external.base.url=https://componentes.idee.es/api-idee-communityplugins

Arquitectura del Sistema

Flujo de Carga de Plugins Externos

1. Inicialización: Al arrancar la API REST, se carga la lista de plugins externos disponibles desde {BASE_URL_COMMUNITY_PLUGINS}/data/plugins.json
2. Validación: Solo se cargan plugins que no estén marcados como obsoletos
3. Carga bajo demanda: Cuando se solicita un plugin externo, se descarga su api.json desde {BASE_URL_COMMUNITY_PLUGINS}/plugins/{nombre_plugin}/dist/api.json
4. Caché: Los plugins externos cargados se almacenan en caché para peticiones posteriores

Uso desde la API REST

Añadir un plugin externo por API-REST

Los plugins externos se utilizan exactamente igual que los plugins internos:

Opción 1 - Como parámetro individual:

https://componentes.idee.es/api-idee/?miPluginExterno=TR*true*false

Opción 2 - Usando el parámetro plugins:

https://componentes.idee.es/api-idee/?plugins=miPluginExterno,otroPlugin

Opción 3 - Combinando ambas formas:

https://componentes.idee.es/api-idee/?miPluginExterno=TR*true&plugins=otroPlugin

Endpoints Disponibles

1. Listar Plugins Externos Disponibles

GET /api/actions/plugins/external

Respuesta:

["plugin1", "plugin2", "plugin3"]

2. Recargar Lista de Plugins Externos

Fuerza una recarga de la lista de plugins externos desde el repositorio remoto:

GET /api/actions/plugins/external/reload

Respuesta:

{
  "success": true,
  "message": "Lista de plugins externos recargada correctamente",
  "count": 15
}

Este endpoint es útil cuando:

• Se han añadido nuevos plugins al repositorio remoto
• Se ha modificado el estado de obsolescencia de algún plugin
• Se necesita limpiar la caché de plugins externos

Ejemplos de uso

1. Listar Plugins Externos Disponibles: https://componentes.idee.es/api-idee/api/actions/plugins/external

2. Añadir plugin interno (layerswitcher) y plugin externo (archetype) por API-REST: https://componentes.idee.es/api-idee/?layerswitcher&archetype