This plugin hasn’t been tested with the latest 3 major releases of WordPress. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress.

Embed Swagger UI

Description

A clean plugin to embed Swagger UI anywhere on your WP website.

How to use?

  • Navigate to WP Swagger UI
  • Select “Add new”
  • Give it a name & Upload the JSON or YAML file.
  • Copy the shortcode like [wpsgui id=xxx] displayed on right or in the “All Swaggers” list.

Donation

Please donate via the link below if you liked my work and if this plugin fulfilled your needs.

https://rzp.io/l/hncvj

Screenshots

  • New “Swagger Ui Integration” menu item.
  • Create a Swagger Snippet & Copy Shortcode.
  • Use the Shortcode wherever you want.
  • Embedded Swagger UI on the front end.

Installation

  1. Go to Plugins in the Admin menu
  2. Click on the button Add new
  3. Search for WP Swagger UI and click ‘Install Now’ or click on the upload link to upload wp-swagger-ui.zip
  4. Click on Activate plugin

FAQ

Do I need a Swagger hub account for this?

No. You don’t require a Swagger hub account for this.

I have a file on a remote server, can I use that?

Yes, you can use the shortcode like this: [wpsgui url=”https://path/to/file.json”] or [wpsgui url=”https://path/to/file.yaml”]

Reviews

Sibat 22, 2024
Brilliant plugin that makes adding API documentation easy. Enables swagger YAML file to be added to existing WP pages. It allows you to either reference an offline file uploaded to WP or reference a single version of the truth hosted on your own server. I must admit I struggled to get this working initially, but as it seemed the most suitable plug-in I could find, I was determined to persevere. Turns out the issues were no fault of the plug-in – just over zealous security precautions on the web hosting site and I was fortunate that the developer was willing to assist – as it was beyond my technical ability to identify what was going on. I am very grateful for the responsiveness of Vinay, in trouble shooting to help find the cause of the issues. He is very knowledgeable and generous with his time.Highly recommended.
Çile 5, 2024 1 reply
It’s a great plugin, the swagger shows beautiful where ever you want on your site. However, it loads your site with JS files even on pages where no swagger is shown. And that is an absolute killer for your site. JS loaded where not needed is terrible and unnecessary. If this is not fixed soon I will have to search for a replacement.
Read all 3 reviews

Contributors & Developers

“Embed Swagger UI” is open source software. The following people have contributed to this plugin.

Contributors

Translate “Embed Swagger UI” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.0.0: April 4, 2023

  • Birthday of WP Swagger UI