Embed Swagger

Provides a shortcode for embedding Swagger specs into pages or posts.

0.8
WPMeta Score

Did you know?

Plugin Popularity 0.0
Author Activity 0.0
  • ๐Ÿ“ฅ Umm.. Very few new users pick this plugin...
  • โค๏ธ Other plugins from this team are not picking up well. Proceed with caution.
  • ๐Ÿ‘จโ€๐Ÿ‘จโ€๐Ÿ‘งโ€๐Ÿ‘ง One man show!! Only a single contributor for this plugin.
  • ๐ŸŽ‚ This plugin celebrated it's 1st anniversary 4 months ago.

Peer Comparison

# Plugin WPMeta Score Users Rating
1Uix Shortcodes – Compatible with Gutenberg1.21,000+5
2External Media Upload0.91,000+4.8
3Download External Images In Posts0.9800+4
4Snippy0.9100+5
5Uix Slideshow0.8100+0
6Content Mask0.8300+5
7Embed Swagger0.8100+0

Description

The shortcode provided by this plugin allows embedding Swagger .json files into WordPress pages and posts. An iframe is used to host the external content, with some styling to mesh it with the host page or post. The external spec is rendered using Swagger UI.

Note that the Swagger UI styling seems to go up to 1500px in width. If the page or post container is less than 1500px wide, the Swagger UI output will appear slightly cut off on the right side, but will otherwise be intact and functional.

Example shortcode usage:

[swagger url="Swagger .json URL goes here"]

An absolute URL must be provided within the quotes. The URL must point to a valid Swagger spec file, typically ending with .json.

Custom styles can be applied to the iframe by adding rules to embed-swagger-container, e.g.:

.embed-swagger-container {
    /* custom styles here */
}

An included script forces the iframe to be as high as needed to show all the contained content, and a stylesheet forces the iframe to take the full width of the parent element.