swagger-gen

1.1.3 • Public • Published

swagger-ui-gen

CircleCI JavaScript Style Guide

Input your swagger.json and generate a static swagger UI. It's the official Swagger UI and you can host it anywhere you like.

Usage

$ npm install -g swagger-gen

$ swagger-gen swagger.json

By default the site will be generated in ./swagger-dist but you can specify a different destination with -d

swagger-gen -d my-swagger-site swagger.json

You can also pipe the swagger JSON into swagger-gen if you wish e.g.

curl http://petstore.swagger.io/v2/swagger.json | swagger-gen

Lastly, you can choose to hide the 'Try it out' buttons provided by the Swagger UI using --no-try-out

swagger-gen swagger.json --no-try-out

Demo

gif-demo

How does it work?

This module bundles up the swagger-ui-dist and makes a few tweaks in the index.html file to include the data from your swagger.json file.

Acknowledgements

This project is kindly sponsored by nearForm

License

MIT

Dependencies (3)

Dev Dependencies (2)

Package Sidebar

Install

npm i swagger-gen

Weekly Downloads

10

Version

1.1.3

License

MIT

Last publish

Collaborators

  • darahayes