3.0.2 ā¢ Published 1 year ago
koa-oas-router v3.0.2
Welcome to koa-oas-router š
This module extends the koa-router with some features usable with oas.
š Homepage
Features
- Extends the normal
koa-router
. - Add routes on runtime from a oas-specification.
- Validates the oas (opt-out possible).
- Generates stubs for not implemented operations (opt-out possible).
Install
npm i koa-oas-router --save
Usage
Javascript
const KoaOasRouter = require('koa-oas-router');
const yamljs = require('yamljs');
const spec = yamljs.load('./oas.yaml');
const router = new KoaOasRouter.KoaOasRouter(opts);
router.addRoutesFromSpecification(spec);
Typescript
import { KoaOasRouter } from 'koa-oas-router';
import * as yamljs from 'yamljs';
const spec = yamljs.load('./oas.yaml');
const router = new KoaOasRouter(opts);
router.addRoutesFromSpecification(spec);
For more detailed information look at the API.
Docs
Run tests
npm run test
Author
š¤ Matthias Hecht
- Github: @matzehecht
š¤ Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Show your support
Give a āļø if this project helped you!
š License
Copyright Ā© 2019 Matthias Hecht.
This project is MIT licensed.