IT 
EN Web Services Documentation is a Joomla extension that provides interactive API documentation inside the Joomla administrator area. It is designed to help developers explore, understand, and test Joomla web services through Swagger UI and Redoc with automatically generated OpenAPI specifications.
Overview
Web Services Documentation is a comprehensive API documentation system for Joomla 6.0+ that provides interactive documentation through Swagger UI and Redoc, with automatic OpenAPI 3.1.0 specification generation based on installed Joomla components.
It is aimed at developers who build integrations, test endpoints, or document custom API-enabled Joomla extensions. The project focuses on seamless Joomla administrator integration, structured navigation, authentication support, and a clean developer experience.
Interactive API docs
Swagger UI allows live exploration and testing of API endpoints directly from the Joomla administrator environment.
Professional reading view
Redoc provides a clean, structured, and highly readable documentation interface with search and navigation.
Automatic generation
The extension can generate OpenAPI specs automatically by scanning installed components and plugin-based routes.
Requirements
The public extension listing describes Web Services Documentation as a free Joomla extension compatible with Joomla 6 and built for API documentation inside the administrator area. It includes a component and a help menu module, which together expose the documentation views and quick access links in the backend.
| Requirement | Detail | Notes |
|---|---|---|
| Joomla | Joomla 6 | The JED listing marks the extension as compatible with Joomla 6. |
| Extension types | Component and module | The listing states that the package includes both a component and a module. |
| Backend access | Administrator area | The documentation interfaces are integrated into the Joomla admin environment. |
| API-enabled site | Useful when Joomla APIs are active | The extension is most valuable when you need to inspect or test available API endpoints. |
Best suited for
- API exploration
- Developer onboarding
- Custom component documentation
- Endpoint testing
- Joomla backend developer workflows
How it works
Web Services Documentation scans installed Joomla components and plugin-based API routes, then builds OpenAPI 3.1.0 specifications that can be displayed through different documentation interfaces. It supports both interactive exploration and cleaner reference-style reading views depending on the interface you choose.
Typical workflow
- Install the extension package in Joomla administrator.
- Open the backend help menu area.
- Choose Documentation, Swagger, or Redoc from the dedicated card links.
- Load a static or generated specification.
- Browse endpoints, authentication details, parameters, and responses.
Interactive API exploration
Swagger UI is the interactive view of the project, allowing developers to inspect operations, review request and response structures, and test endpoints from a documentation-first workflow.
Access from Help menu
Access to Swagger and Redoc is provided through the Joomla administrator Help menu by using the links exposed in the dedicated card. This makes the documentation easy to reach from the backend without requiring developers to memorize custom routes or separate entry points.
How to open it
- Log in to Joomla administrator.
- Open the Help menu.
- Locate the card added by Web Services Documentation.
- Click the link for Swagger, Redoc, or the main documentation view.
- Start browsing the available API documentation interfaces.
Backend Help menu integration
The package includes a dedicated help menu module that adds quick access buttons for the available documentation views directly inside the Joomla administrator area.
Specification options
The extension provides three specification modes: a static pre-generated core Joomla API spec, a dynamically generated spec based on active plugins, and a broader generated spec that includes all installed components. This gives developers a practical choice between stable reference material and a more environment-aware documentation output.
| Specification | What it includes | Best for |
|---|---|---|
| Static Spec | Pre-generated core Joomla APIs | Stable reference documentation. |
| Generated (Active Plugins) | Dynamic spec based on enabled plugins | Current working environment inspection. |
| Generated (All Components) | Complete spec including installed components | Broader discovery and documentation coverage. |
Why this matters
Different teams need different levels of API visibility. Static specs are useful for consistency, while generated specs are better when you need documentation that reflects the real state of a Joomla installation.
Features
The public extension page highlights dual documentation interfaces, automatic OpenAPI generation, hierarchical navigation, dark mode support, authentication handling, and backend integration as core project features.
Swagger UI
Interactive API explorer with live testing, request and response examples, and built-in authorization support.
Redoc
Professional reading view with structured layout, search, sticky navigation, and dark mode support.
Automatic OpenAPI
Generates OpenAPI 3.1.0 specs from installed components, routes, and plugin-based APIs.
Hierarchical navigation
Organizes documentation through a structured tag hierarchy for easier browsing of large API sets.
Swagger UI
Swagger is the more interactive interface and is especially useful when you want to inspect endpoint details, review schemas, and try authenticated requests while staying inside a documentation-driven workflow.
Redoc
Redoc is the cleaner reference interface and works well when you want a more documentation-oriented reading experience, especially for browsing larger APIs with less visual noise.
Authentication
The extension includes token-aware authentication support, with automatic API token generation and reuse integrated into Swagger UI authorization flows. According to the project description, tokens are stored securely in Joomla and permission checks are applied across the workflow.
Automatic token handling
Tokens can be generated and reused automatically for existing users in supported workflows.
Swagger authorization
Authentication integrates with the Swagger UI interface so secured endpoints can be tested more easily.
Permission checks
The project description emphasizes proper permission validation throughout the extension workflow.
Secure storage
API token data is managed through Joomla’s own environment rather than an external service.
Useful reference
For broader background on Joomla core APIs and available endpoint examples, the official Joomla documentation page Joomla Core APIs is a helpful companion resource.
Use cases
- Exploring available Joomla API endpoints in a structured way.
- Testing authenticated requests through an interactive interface.
- Documenting custom API-enabled Joomla components for internal or team use.
- Helping developers understand parameters, filters, responses, and route patterns.
- Improving backend developer workflows with faster access to API references.
- Supporting onboarding for developers who are new to Joomla web services.
Why use it
Joomla APIs are much easier to understand when routes, parameters, authentication, and response structures are visible in one place. This extension brings that visibility directly into the administrator interface and makes the documentation much more practical for real development work.
Troubleshooting
Swagger or Redoc links do not appear
Check that the help menu module is installed, enabled, and visible in the Joomla administrator backend.
The generated specification looks incomplete
Verify whether you are using the static spec, the active-plugins spec, or the all-components spec, because each option exposes a different scope.
Authenticated testing does not work
Confirm that API tokens are available and that the current user has the required permissions for the endpoints you are testing.
A route is missing from the docs
Check whether the route comes from an installed component, an enabled plugin, or a custom API integration that is not currently exposed in the selected spec mode.
The backend entry point is hard to find
Use the Joomla administrator Help menu and open the links from the dedicated card provided by the extension.
You need deeper Joomla API details
Use the official Joomla Core APIs documentation as a reference for example endpoints, request formats, and broader API coverage.