# @imnotjames/koa-openapi-router

> An OpenAPI Router for Koa

Latest version **0.0.2** (published 2020-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @imnotjames/koa-openapi-router
pnpm add @imnotjames/koa-openapi-router
yarn add @imnotjames/koa-openapi-router
bun add @imnotjames/koa-openapi-router
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-08-09 |
| First published | 2020-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 35.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | James Ward |
| Maintainers | imnotjames |
| Keywords | openapi, swagger, koa |

## Links

- npm: https://www.npmjs.com/package/@imnotjames/koa-openapi-router
- Repository: https://github.com/imnotjames/koa-openapi-router
- Homepage: https://github.com/imnotjames/koa-openapi-router#readme
- Issues: https://github.com/imnotjames/koa-openapi-router/issues
- npm.io page: https://npm.io/package/@imnotjames/koa-openapi-router

## Dependencies (2)

- [@koa/router](https://npm.io/package/@koa/router.md) ^9.3.1
- [openapi-framework](https://npm.io/package/openapi-framework.md) ^7.0.0

## Recent versions

- 0.0.2 (latest) — 2020-08-09
- 0.0.1 — 2020-07-26

## README

# Koa OpenAPI Router

Creates a [Koa Router][koa-router] from [an OpenAPI document][openapi-doc]
via [the OpenAPI Framework Package][openapi-framework].

This sets up the routes, body parsing, request validation,
response validation, security, and default parameters.

## Installation

Install using [npm][npm] or [yarn][yarn]

```shell script
# npm
npm install @imnotjames/koa-openapi-router

# yarn
yarn add @imnotjames/koa-openapi-router
```

## Getting Started

**WIP**

Start with an OpenAPI Document

Create Operations - similar to standard koa middleware

Define the application.

```javascript
const app = new Koa();

const router = getRouter({ apiDoc, operations });

app
  .use(router.routes())
  .use(router.allowedMethods());

app.listen(8080);
```

[koa-router]: https://github.com/koajs/router
[openapi-doc]: https://swagger.io/specification/
[openapi-framework]: https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-framework#readme
[npm]: https://www.npmjs.org/

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