Content Plugin ID: plg_content_swaggerui
A powerful integration tool to render interactive API documentation directly within your Joomla articles.
Key Benefits
Interactive Testing
Allow developers to test your API endpoints directly from the browser without leaving your site.
Automated Rendering
Convert OpenAPI/Swagger JSON or YAML files into beautiful, readable documentation instantly.
Installation Guide
1 Download the plg_content_swaggerui-1.0.0.zip from the Download Center.
2 In your Joomla Admin, navigate to System > Install > Extensions.
3 Upload the ZIP file. Once successful, go to System > Plugins.
4 Search for "Content - SwaggerUI" and click the status to Enable it.
How to Use
To display your API documentation in an article, simply use the following shortcode syntax:
{swaggerui url="https://yoursite.com/api/spec.json"}Note: Ensure the URL provided is a valid JSON or YAML OpenAPI specification. The plugin will automatically inject the SwaggerUI CSS and JS to render the interface.
Resources & Links