The Story & Motivation
This plugin was born out of a specific need in Computer Science Campuses and Technical Training Environments.
In typical LMS environments, sharing API specifications usually means uploading a raw YAML file for students to download, or embedding an external URL (SwaggerHub, etc.) via iframe. Neither solution provides a seamless learning experience.
We wanted to bring the developer experience (DX) directly into the course. Students should be able to read, explore, and implement APIs without leaving the Moodle interface and without depending on external tools that might be blocked by campus firewalls.
The Inspiration
Our main inspiration was the GitLab default OpenAPI viewer and professional IDEs like WebStorm. We loved how GitLab detects a spec file and simply renders it.
Key Features
- Offline First / Privacy Focused: Injects rendering engines directly from the server’s local storage. Works perfectly in Intranets or air-gapped environments.
- OpenAPI Dual Engine: Smart Switcher that allows users to toggle instantly between Swagger UI and Redoc.
- AsyncAPI v3 Support: Native support for the latest Event-Driven Architecture specifications.
- GitLab-Style Toolbar: Switch instantly between the Rendered View and Raw Code with a single click. Includes Dark Mode.
- Clean UI: Removes standard Moodle clutter to provide a “Full Focus” reading mode.
Supported Formats
- AsyncAPI (v2.0 - v3.0)
- OpenAPI (Swagger v3 and Redoc)
- Markdown (.md)