Skip to content

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

License

Notifications You must be signed in to change notification settings

afgarcia86/bootstrap-swagger-ui

 
 

Repository files navigation

Bootsrap Swagger UI Theme

Based off of Swagger UI responsive theme modified to use bootstrap v4.0.0-beta.3 and refactored a bit for added flexibility.

Swagger Theme example

The theme will adapt to screen size and works on tablets and mobile phones.

Swagger Theme example

Give it a try and enter your own swagger definition.

Customizing The Theme

  • Includes Bootstrap v4.0.0-beta.3 SCSS
  • Uses broserSync for live reloading
  1. $npm install
  2. $gulp serve
  3. Update Sass
  4. Update Templates
  5. Update JS

Updating ui-assets

git subtree split --branch ui-assets --prefix dist/assets/ && git checkout ui-assets && git push && git checkout master

Adding as subtree to another repository

git subtree add --prefix api/app/lib/openapi/ui/assets https://github.com/afgarcia86/bootstrap-swagger-ui ui-assets --squash

Update subtree

git subtree pull --prefix api/app/lib/openapi/ui/assets https://github.com/afgarcia86/bootstrap-swagger-ui ui-assets --squash

Disclaimer

This is not a fully polished implementation and should be used with care.

About

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 61.4%
  • CSS 25.8%
  • HTML 12.4%
  • Dockerfile 0.4%