JSPM

foxify-swaggerize-ui

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q30936F
  • License MIT

Foxify middleware to display a swagger-ui 3 page

Package Exports

  • foxify-swaggerize-ui

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (foxify-swaggerize-ui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

foxify-swaggerize-ui

foxify-swaggerize-ui is an node foxify middleware to show swagger-ui 3 for your local (or external) api.

Installation

npm i foxify-swaggerize-ui

Usage

const Foxify   = require('foxify');
const app       = new Foxify();
const swaggerUi = require('foxify-swaggerize-ui');

app.use('/api-docs.json', function (req, res) {
  res.json(require('./path/to/swaggerize/docs.json'));
});
app.use('/api-docs', swaggerUi());

app.listen(3000);

Generate swagger doc.json

foxify-swagger-generator