oas3-validator
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

oas3-chow-chow

Request and response validator against OpenAPI Specification

Build Status npm

Notes

If you are looking for framework specific middleware, you might want to look at following libraries that use oas3-chow-chow under the hood.

koa-oas3

Installation

$ yarn add oas3-chow-chow
# Or 
$ npm i oas3-chow-chow

Usage

import ChowChow from "oas3-chow-chow";
import * as fs from "fs";
import * as yaml from "js-yaml";
 
var doc = yaml.safeLoad(fs.readFileSync("./openapi.yml", "utf8"));
const chow = new ChowChow(doc);
 
chow.validateRequest("./books", {
  method: "post",
  query: {
    expand: ["document", "author"]
  },
  body: {
    name: "a nice book",
    author: "me me me"
  }
});
 
chow.validateResponse("./books", {
  method: "post",
  header: {
    "content-type": "application/json"
  },
  body: {
    name: "a nice book",
    author: "me me me"
  }
});

Readme

Keywords

none

Package Sidebar

Install

npm i oas3-validator

Weekly Downloads

3

Version

1.0.0

License

MIT

Unpacked Size

55.7 kB

Total Files

63

Last publish

Collaborators

  • pierresaux