Home

Awesome

express-swagger-ui NPM version

Serve swagger-ui with express.js (without hacking node_modules/swagger-ui/dist/index.html)

Install

Install with npm

$ npm i express-swagger-ui --save

(optional) Install peer dependencies

npm i -S express swagger-ui

Usage

const express = require('express');
const app = express();
require('express-swagger-ui')({
  app       : app,
  swaggerUrl: '/swagger.json',  // this is the default value
  localPath : '/explorer'       // this is the default value
});

API

<!-- add a path or glob pattern for files with code comments to use for docs -->

{%= apidocs("index.js") %}

Related projects

<!-- add an array of related projects, then un-escape the helper -->

{%= related([]) %}

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Andreas Pizsa

License

Copyright © 2016 Andreas Pizsa Released under the MIT license.

This file was generated by verb-cli on April 06, 2016.