node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org ยป

flair-ui

flair-ui

An express module that bundles the swagger-ui as a mountable thing. It can be used with any REST service that produces a swagger compliant JSON description.

Note that no changes have been made to the UI apart from templating the initial page to allow passing in of options from the express app.

Installation

    npm install flair-ui

Usage

    var flairui = require('flair-ui');
    //mounts the html docs and api explorer on /docs
    //(needs to know the location of swagger json - could be passed absolute or relative url)
    app.get("/docs", flairui("/api-doc"));
    app.use(express.static('node_modules/flair-ui/node_modules/swagger-ui/dist'));

Licence

Apache Licence 2.0 - same as swagger-ui.