1.0.0 • Published 6 years ago
oas3-validator v1.0.0
oas3-chow-chow
Request and response validator against OpenAPI Specification
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.
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"
}
});
1.0.0
6 years ago