SwaggerUI for Joomla

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 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
 Download v2.1.0
 Source on GitHub
Changelog
Comments
 Demo

Requirements:
Joomla 5.0 or higher
PHP 8.1 or higher

Project Updates

Version 2.1.0

plugin
CHANGES
  • Namespace

Version 2.0.1

plugin
ADDITIONS
  • Code clean

Version 2.0.0

plugin
ADDITIONS
  • Added support for CDN assets
  • Use Web Asset Manager

Version 1.0.0

plugin
ADDITIONS
  • Test webservices endpoint
LANGUAGE UPDATES
  • en-GB
NOTES
  • Not listed on Joomla Extension Directory

Page 3 of 3

Extensions