# koa-swaggerize-ui

> Koa middleware to display a swagger-ui 3 page

Latest version **1.1.0** (published 2020-04-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-swaggerize-ui
pnpm add koa-swaggerize-ui
yarn add koa-swaggerize-ui
bun add koa-swaggerize-ui
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-04-13 |
| First published | 2020-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 8.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | yadickson |
| Maintainers | yadickson |
| Keywords | swagger-ui, swaggerize, koa, middleware, swagger-ui-3 |

## Links

- npm: https://www.npmjs.com/package/koa-swaggerize-ui
- Repository: https://github.com/yadickson/koa-swaggerize-ui
- Issues: https://github.com/yadickson/koa-swaggerize-ui/issues
- npm.io page: https://npm.io/package/koa-swaggerize-ui

## Dependencies (3)

- [koa](https://npm.io/package/koa.md) ^2.11.0
- [koa-mount](https://npm.io/package/koa-mount.md) ^4.0.0
- [koa-static](https://npm.io/package/koa-static.md) ^5.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2020-04-13
- 1.0.0 — 2020-04-13

## README

### koa-swaggerize-ui

[![TravisCI Status][travis-image]][travis-url]
[![npm version][npm-image]][npm-url]

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](https://github.com/yadickson/koa-swagger-generator-api)


## License

MIT © [Yadickson Soto](https://github.com/yadickson)

Thanks to [express-swaggerize-ui](https://github.com/pgroot/express-swaggerize-ui)

[travis-image]: https://travis-ci.org/yadickson/koa-swaggerize-ui.svg?branch=master
[travis-url]: https://travis-ci.org/yadickson/koa-swaggerize-ui

[npm-image]: https://badge.fury.io/js/koa-swaggerize-ui.svg
[npm-url]: https://badge.fury.io/js/koa-swaggerize-ui

---
_Source: https://npm.io/package/koa-swaggerize-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._