Web Services Documentation

Joomla!LABS Web Services Documentation

Perfect for developers building integrations, testing APIs, or documenting custom components. Features intelligent hierarchical navigation, dark mode support, and seamless Joomla admin integration.

? Features

? Dual Documentation Interfaces

Swagger UI
- Interactive API explorer with live testing
- Hierarchical navigation (up to 4-level tag tree)
- Request/response examples with syntax highlighting
- Built-in authentication with automatic token injection
- Filter parameter detection and documentation
- Custom hierarchical tags plugin for organized navigation

Redoc
- Clean, professional documentation interface
- Dark mode with automatic Joomla theme synchronization
- Responsive design optimized for all devices
- Fast rendering with virtual scrolling
- Three-panel layout with search functionality
- Sticky navigation for easy browsing

? Automatic OpenAPI Generation

• Dual-mode generator: CLI script and web-accessible PHP
• Component scanning: Discovers all installed component endpoints
• Plugin support: Detects plugin-based API routes
• Custom route parsing: Handles complex Joomla routing patterns
• Filter extraction: Automatically documents query parameters
• Smart deduplication: Prevents duplicate parameter definitions
• Hierarchical tags: Generic path-based hierarchy (1-4 levels)

? Three Spec Options

1. Static Spec: Pre-generated core Joomla APIs
2. Generated (Active Plugins): Dynamic spec with enabled plugins
3. Generated (All Components): Complete spec including all installed components

? Security & Authentication

• Automatic API token generation and management
• Secure token storage in Joomla database
• Token reuse for existing users
• Integration with Swagger UI authorization
• Proper permission checks throughout

? Joomla Integration

Component (com_joomlalabs_webservices)
- Three views: Documentation, Swagger, Redoc
- Admin menu integration
- WebAssetManager for optimized asset loading
- PSR-4 namespacing
- Service Provider architecture

Help Menu Module (mod_joomlalabs_webservices_helpmenu)
- Quick access buttons in admin help menu
- Links to Documentation, Swagger, and Redoc
- Proper icon integration