swagger-ui-cornify
Advanced tools
Comparing version 2.0.0-beta.2 to 2.0.0
{ | ||
"name": "swagger-ui-cornify", | ||
"version": "2.0.0-beta.2", | ||
"version": "2.0.0", | ||
"author": "Kyle Shockey <kyleshockey@gmail.com>", | ||
@@ -5,0 +5,0 @@ "description": "Cornify plugin for Swagger-UI v3", |
# swagger-ui-cornify | ||
Cornify plugin for Swagger-UI v3 | ||
Cornify plugin for Swagger-UI v3. | ||
This is a lighthearted example of how to create an external plugin for Swagger-UI. This project has a minimal Webpack build pipeline that creates bundles for browser consumption. | ||
The plugin is available on npm as `swagger-ui-cornify`, and minified release copies are attached to each [GitHub Release](https://github.com/shockey/swagger-ui-cornify/releases). | ||
If you use the script directly, the module will be exposed on the global scope as `SwaggerUICornify`. | ||
### How to use | ||
Load this plugin (either through npm or directly), and provide it to Swagger-UI when you call it: | ||
```js | ||
SwaggerUI({ | ||
url: "http://petstore.swagger.io/v2/petstore.yaml", | ||
plugins: [ | ||
SwaggerUICornify | ||
] | ||
}) | ||
``` | ||
If/when the API definition you're viewing contains an `x-cornify: true` statement, magic will happen. |
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
57963
0
25