https://github.com/rickyli79/koa-openapi-router
"config koa-router by openapi, valid the request by opanapi
https://github.com/rickyli79/koa-openapi-router
koa openapi router schema valid
Last synced: 23 days ago
JSON representation
"config koa-router by openapi, valid the request by opanapi
- Host: GitHub
- URL: https://github.com/rickyli79/koa-openapi-router
- Owner: RickyLi79
- License: mit
- Created: 2021-02-16T17:32:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-26T17:28:14.000Z (almost 5 years ago)
- Last Synced: 2025-10-25T18:54:25.081Z (4 months ago)
- Topics: koa, openapi, router, schema, valid
- Language: TypeScript
- Homepage:
- Size: 650 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @rickyli79/koa-openapi-router
[![NPM version][npm-image]][npm-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/@rickyli79/koa-openapi-router.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@rickyli79/koa-openapi-router
[download-image]: https://img.shields.io/npm/dm/@rickyli79/koa-openapi-router.svg?style=flat-square
[download-url]: https://npmjs.org/package/@rickyli79/koa-openapi-router
English | [[简体中文]](./README.zh-CN.md)
Overview | [[Config]][2] | [[Controller]][3] | [[Validate]][4] | [[File Watcher]][5]
[1]:README.md
[2]:./docs/en/Config.md
[3]:./docs/en/Controller.md
[4]:./docs/en/Validate.md
[5]:./docs/en/FileWatcher.md
---
#### Description
- init `koa-router` and connect `controller` by Openapi-doc
- validate the request and response by Openapi-doc
- watch Openapi-doc changes, no need to reboot app. handy in develment environment
#### Installation
```shell
npm i -S @rickyli79/koa-openapi-router
```
#### Usage Example
[Example](./test)
#### Test Report
[Allure Report](https://rickyli79.github.io/testing-reports/koa-openapi-router/allure-report/)
#### egg-plugin version
https://github.com/RickyLi79/egg-openapi-router