IT 
EN 
Comprehensive API documentation system for Joomla. Provides interactive Swagger UI and Redoc interfaces with automatic OpenAPI 3.1.0 specification generation from your installed components.
Overview
Perfect for developers building integrations, testing APIs, or documenting custom components. It features intelligent hierarchical navigation, dark mode support, and seamless integration directly into the Joomla administration panel.
Dual Interfaces
Choose between interactive Swagger UI for live testing or clean Redoc for professional reading.
Auto-Generation
Automatically parses Joomla routes and plugins to build dynamic OpenAPI 3.1.0 specs.
Auto Auth
Generates and injects API tokens securely into Swagger UI for immediate endpoint testing.
At a glance
- Interactive API explorer with live testing.
- Hierarchical navigation (up to 4-level tag tree).
- Dual-mode generator: CLI script and web-accessible PHP.
- Includes admin help menu module for quick access.
- Built for Joomla 6.0+ with WebAssetManager and PSR-4.
Interfaces & Tools
A complete suite of tools integrated directly into your Joomla dashboard.
Swagger UI Explorer
Test endpoints live directly from the admin panel. Features automatic token injection and request examples.
Redoc Interface
Clean, three-panel layout optimized for reading. Includes dark mode synced with the Joomla theme.
Spec Generator
Choose between Static Core Specs, Active Plugins only, or Full installed components generation.
Key features
- Smart discovery: Scans and discovers all installed component endpoints and plugin-based routes automatically.
- Filter extraction: Automatically documents query parameters and handles complex Joomla routing patterns.
- Secure authentication: Secure token storage in Joomla database with proper permission checks throughout.
- Smart deduplication: Advanced algorithms prevent duplicate parameter definitions in generated OpenAPI specs.
- Help menu integration: Includes a module (`mod_joomlalabs_webservices_helpmenu`) for quick access from the admin header.
- Modern architecture: Built using Joomla WebAssetManager, Service Providers, and strict PSR-4 namespacing.
Three Spec Options
Static Spec
Pre-generated core Joomla APIs. Ideal for standard integrations that don't rely on third-party components.
Generated (Active Plugins)
Dynamic spec that includes core APIs plus any endpoints exposed by currently enabled plugins.
Generated (All Components)
The complete picture. Scans and documents the entire ecosystem of installed Joomla components and custom APIs.
Installation
Download
Get the full package (.zip) including Component and Module from GitHub.
Install
Go to System → Install → Extensions and upload the downloaded zip.
Access
Find the tools under the Components → Web Services Documentation menu.
Requirements
- Joomla 6.0 or newer.
- PHP 8.1+ recommended.
- Joomla Core API enabled.
Note: For custom component parsing, the target components must follow standard Joomla routing and API MVC structures.