https://github.com/uskov-anton/koa-swagger-validator
Koa 2 + Swagger 2 + Swagger-tools
https://github.com/uskov-anton/koa-swagger-validator
koa koa-compose koa-connect koa2 koajs middleware swagger swagger-tool swagger-tools swagger-validator swagger2 validation validator
Last synced: about 2 months ago
JSON representation
Koa 2 + Swagger 2 + Swagger-tools
- Host: GitHub
- URL: https://github.com/uskov-anton/koa-swagger-validator
- Owner: uskov-anton
- License: mit
- Created: 2018-11-26T05:27:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T22:11:41.000Z (over 2 years ago)
- Last Synced: 2025-03-12T20:39:22.975Z (3 months ago)
- Topics: koa, koa-compose, koa-connect, koa2, koajs, middleware, swagger, swagger-tool, swagger-tools, swagger-validator, swagger2, validation, validator
- Language: JavaScript
- Size: 679 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-swagger-validator
> Koa 2 + Swagger 2 + Swagger-tools
## Install
```bash
$ npm install koa-swagger-validator --save
```
or
```bash
$ yarn add koa-swagger-validator
```
## Usage
### `validator(spec) => koa2 middleware`
```javascript
import validator from "koa-swagger-validator";
import spec from "./swagger.json";
(async () => {
const app = new Koa();
app.use(await validator(spec));
})();
```
### `validator(spec, options) => koa2 middleware`
```javascript
import validator from "koa-swagger-validator";
import spec from "./swagger.json";
(async () => {
const app = new Koa();
app.use(await validator(spec, { /* ... */ }));
})();
```
## Documentation
|Variable|Type|Required|
|--------|----|--------|
|spec|object|yes|
|options|object|no|
### spec
[Swagger RESTful API Documentation Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#schema)
### options
|Properties|Type|Required|
|----------|----|--------|
|[security](https://github.com/apigee-127/swagger-tools/blob/master/docs/Middleware.md#swagger-security)|object|no|
|[validator](https://github.com/apigee-127/swagger-tools/blob/master/docs/Middleware.md#swagger-validator)|object|no|
|[router](https://github.com/apigee-127/swagger-tools/blob/master/docs/Middleware.md#swagger-router)|object|no|
|[ui](https://github.com/apigee-127/swagger-tools/blob/master/docs/Middleware.md#swagger-ui)|object|no|
> See also swagger-tools [full documentation](https://github.com/apigee-127/swagger-tools/blob/master/docs/Middleware.md).
## Limitations
- Koa 2
- Swagger 2
## Credits
- [koa-connect](https://github.com/vkurchatkin/koa-connect)
- [koa-compose](https://github.com/koajs/compose)
- [swagger-tools](https://github.com/apigee-127/swagger-tools)
## License
[MIT](LICENSE)