← Volver a proyectos

ApiDocs: Módulo de Moodle para Documentación de APIs

Backend / Systems Engineer

Plugin de Moodle para renderizado nativo y offline de especificaciones OpenAPI, AsyncAPI y documentación Markdown dentro del LMS.

Stack:
PHP (Moodle plugin)JavaScript (React)OpenAPIAsyncAPI
Ver en GitHub →
ApiDocs: Módulo de Moodle para Documentación de APIs - Captura 1
ApiDocs: Módulo de Moodle para Documentación de APIs - Captura 2
ApiDocs: Módulo de Moodle para Documentación de APIs - Captura 3

Problema

Entornos educativos con acceso restringido a internet o redes air-gapped necesitan acceso a documentación técnica de APIs sin dependencias externas.

Solución

Módulo de curso Moodle que renderiza especificaciones de APIs y documentación técnica completamente offline.

Tecnología

  • Inyección local de renderizadores basados en React (Swagger UI, Redoc, AsyncAPI Standalone)
  • Motor dual de renderizado OpenAPI con selector en tiempo de ejecución
  • Soporte para AsyncAPI v3 en arquitecturas event-driven
  • Renderizado Markdown con GitHub-Flavored Markdown
  • UI optimizada para lectura dentro de Moodle

Destacados

  • Totalmente offline, sin dependencias de CDN externos
  • Toolbar estilo GitLab: cambio entre código crudo y vista renderizada
  • Soporte de modo oscuro
  • Enfoque en experiencia de desarrollador e integración con LMS

Para ver el código fuente y leer más sobre la integración técnica de esta herramienta de documentación de APIs, puedes visitar el repositorio oficial en GitHub. Para ver más Plugins for Moodle™, visita plugins.mrjacket.dev.