AWS API Gateway Model Validation CLI tool
- TypeScript 95.7%
- JavaScript 3.9%
- Batchfile 0.4%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .github/workflows | ||
| bin | ||
| examples | ||
| openspec | ||
| schema | ||
| src | ||
| test | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .travis.yml | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
apigw-model-validator
A simple tool for validation request payloads against AWS Api Definitions
Usage
$ npm install -g apigw-model-validator
$ apigw-model-validator COMMAND
running command...
$ apigw-model-validator (-v|--version|version)
apigw-model-validator/1.0.0 darwin-x64 node-v12.18.3
$ apigw-model-validator --help [COMMAND]
USAGE
$ apigw-model-validator COMMAND
...
const AMV = require('apigw-model-validator')
const validator = new AMV()
validator.isPayloadValid({
model: 'UserDetails',
payload: {
username: 'Joe Bloggs'
},
schema: './user.yml'
})
.then(() => {
console.log('Payload is valid)
})
.catch(err => {
console.error('Payload is invalid, err)
})
validator.isPayloadValid({
path: '/app/use-details',
payload: {
username: 'Joe Bloggs'
},
requestMethod: 'POST',
schema: './user.yml'
})
.then(() => {
console.log('Payload is valid)
})
.catch(err => {
console.error('Payload is invalid, err)
})