Skip to content

yadickson/koa-swaggerize-ui

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

koa-swaggerize-ui

TravisCI Status npm version

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

Installation

npm install --save koa-swaggerize-ui

Usage

const Koa       = require('koa');
const app       = new Koa();
const swaggerUi = require('koa-swaggerize-ui');

app.use('/api-docs.json', async function (ctx) {
  ctx.body = await require('./path/to/swaggerize/docs.json');
});

app.use(swaggerUi());

app.listen(3000);

Routes

http://localhost:3000/api-docs

http://localhost:3000/api-docs.json

Generate swagger doc.json

koa-swagger-generator-api

License

MIT © Yadickson Soto

Thanks to express-swaggerize-ui

About

Fork Express middleware to display a swagger-ui 3.x page for Koa

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 93.3%
  • JavaScript 6.7%