Historia y Motivación
Este plugin nace de una necesidad específica en Campus de Informática y Entornos de Formación Técnica.
En entornos LMS típicos, compartir especificaciones de API usualmente significa subir un archivo YAML plano para que los estudiantes lo descarguen, o incrustar una URL externa (SwaggerHub, etc.) vía iframe. Ninguna de estas soluciones ofrece una experiencia de aprendizaje fluida.
Queríamos llevar la experiencia de desarrollo (DX) directamente al curso. Los estudiantes deberían poder leer, explorar e implementar APIs sin salir de la interfaz de Moodle y sin depender de herramientas externas que podrían estar bloqueadas por firewalls corporativos.
La Inspiración
Nuestra principal inspiración fue el visor OpenAPI por defecto de GitLab y los entornos de desarrollo (IDE) profesionales como WebStorm. Nos encantaba cómo GitLab detecta un archivo de especificación y simplemente lo renderiza.
Características Clave
- Offline First / Enfoque en Privacidad: Inyecta los motores de renderizado directamente desde el almacenamiento local del servidor. Funciona perfectamente en intranets.
- Motor Dual OpenAPI: Selector inteligente que permite a los usuarios alternar instantáneamente entre Swagger UI y Redoc.
- Soporte AsyncAPI v3: Soporte nativo para las últimas especificaciones de Arquitectura Orientada a Eventos.
- Barra de Herramientas (Estilo GitLab): Cambia instantáneamente entre la Vista Renderizada y el Código Crudo con un solo clic. Incluye Modo Oscuro.
- Interfaz Limpia: Elimina las distracciones de la interfaz de Moodle para proporcionar un modo de lectura de “Enfoque Total”.
Formatos Soportados
- AsyncAPI (v2.0 - v3.0)
- OpenAPI (Swagger v3 y Redoc)
- Markdown (.md)