Skip to content

An angular module for presenting API documentation generated by Swagger

Notifications You must be signed in to change notification settings

vineey/angular-swagger

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Modification

This fork is intended to make the swagger template customizable by externalizing the directive templates from the main js file.

##angular-swagger

This module provides a simple, minimal interface for reading Swagger documentation.

The interface is built using ordinary Bootstrap components, so you should find it very easy to theme and style.

Dependencies

This requires AngularJS. In addition, you will need:

Installation

  1. Install with bower using bower install ng-swagger-ui

  2. Include ng-swagger-ui.js, which should be located in bower_components/ng-swagger-ui

  3. Include bootstrap.min.css (which should be in bower_components/bootstrap/dist/css)

  4. Include ui-bootstrap-tpls.min.js (in bower_components/angular-bootstrap)

  5. Include showdown.js (in bower_components/showdown/compressed)

  6. Add angular-swagger as a module dependency to your app.

Usage

Simply create the following element

<swagger-apis url='path/to/swagger' />

where path/to/swagger is the location of your swagger documentation (usually /api-docs/)

About

An angular module for presenting API documentation generated by Swagger

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 67.6%
  • HTML 32.4%