ApiDocs: Moodle Module for API Documentation
Role: Backend / Systems Engineer
Moodle plugin for native and offline rendering of OpenAPI, AsyncAPI specifications and Markdown documentation within the LMS.
Technologies
Problem
Educational environments with restricted internet access or air-gapped networks need access to technical API documentation without external dependencies.
Solution
Moodle course module that renders API specifications and technical documentation completely offline.
Technology
- Local injection of React-based renderers (Swagger UI, Redoc, AsyncAPI Standalone)
- Dual OpenAPI rendering engine with runtime selector
- AsyncAPI v3 support for event-driven architectures
- Markdown rendering with GitHub-Flavored Markdown
- UI optimized for reading within Moodle
Highlights
- Fully offline, no external CDN dependencies
- GitLab-style toolbar: switch between raw code and rendered view
- Dark mode support
- Focus on developer experience and LMS integration
To view the source code and read more about the technical integration of this API documentation tool, you can visit the official repository on GitHub. To see more Plugins for Moodle™, visit plugins.mrjacket.dev.