Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/griboedow/swaggerdoc
Mediawiki extension to provide swagger ui frontend for any swagger specification
https://github.com/griboedow/swaggerdoc
mediawiki-extension php swagger swagger-ui
Last synced: 2 months ago
JSON representation
Mediawiki extension to provide swagger ui frontend for any swagger specification
- Host: GitHub
- URL: https://github.com/griboedow/swaggerdoc
- Owner: Griboedow
- License: mit
- Created: 2022-01-29T16:09:22.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-26T16:47:08.000Z (6 months ago)
- Last Synced: 2024-10-10T18:50:50.926Z (3 months ago)
- Topics: mediawiki-extension, php, swagger, swagger-ui
- Language: PHP
- Homepage: https://www.mediawiki.org/wiki/Extension:SwaggerDoc
- Size: 2.52 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwaggerDoc
[Mediawiki extension](https://www.mediawiki.org/wiki/Extension:SwaggerDoc) to provide swagger ui frontend for any swagger specification.
To install, clone the extension and add to **LocalSettings.php**:
```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:
```html
```
```html
```
- Save page and refresh it. You will see:
