Skip to content

Mediawiki extension to provide swagger ui frontend for any swagger specification

License

Notifications You must be signed in to change notification settings

Griboedow/SwaggerDoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SwaggerDoc

Mediawiki extension to provide swagger ui frontend for any swagger specification.

To install, clone the extension and add to LocalSettings.php:

wfLoadExtension('SwaggerDoc');

Usage

To use it, you need to

  • Create a wikipage (for example, MySwaggerJsonSpec page) with swagger spec (json file). You may also want to change wikipage schema to JSON but that is not mandatory
    • Alternatively, you can upload your spec as a file
  • On another wikipage insert Swagger doc tag with either specUrl or specUrls arguments.

    Please note that URL should be a link to the raw JSON (not to a page containing it); typically that is achievable by adding ?action=raw to the URL:
<SwaggerDoc specUrls="[{'url': 'http://MyWiki/index.php/MySwaggerJsonSpec?action=raw', 'name': 'My swagger spec'}]" />
<SwaggerDoc specUrl="http://MyWiki/index.php/MySwaggerJsonSpec?action=raw" />
  • Save page and refresh it. You will see: Capture

About

Mediawiki extension to provide swagger ui frontend for any swagger specification

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published