![License: MIT](https://camo.githubusercontent.com/b59ba4ef5c86bc79e9e3e9039f1b96a4db59e7f96a7ba04abfc6548ae88c461b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e2e737667)
This library expose some methods to validate request, parameters, headers and response based on your OpenAPI Json definition.
validate(openApiDef, options) -> {ValidationMethods}
You can checkout more info about this method in our Docs link.
Parameters
Name |
Type |
Description |
openApiDef |
object |
OpenAPI definition |
options |
object |
Options to extend the errorHandler, strictValidation or Ajv configuration |
Returns:
validator methods
These are the object keys the validate method returns.
{
validateRequest,
validateQueryParam,
validatePathParam,
validateHeaderParam,
validateResponse,
}
validateRequest(payload, endpoint, method, contentType)
Name |
Type |
Description |
payload |
object |
Payload we want to validate |
endpoint |
string |
OpenApi endpoint we want to validate |
method |
string |
OpenApi method we want to validate |
contentType |
string |
Content api of the request we want to validate. Optional |
validateQueryParam(payload, endpoint, method, contentType)
Name |
Type |
Description |
payload |
object |
Payload we want to validate |
endpoint |
string |
OpenApi endpoint we want to validate |
method |
string |
OpenApi method we want to validate |
contentType |
string |
Content api of the request we want to validate. Optional |
validatePathParam(payload, endpoint, method, contentType)
Name |
Type |
Description |
payload |
object |
Payload we want to validate |
endpoint |
string |
OpenApi endpoint we want to validate |
method |
string |
OpenApi method we want to validate |
contentType |
string |
Content api of the request we want to validate. Optional |
validateHeaderParam
validateHeaderParam(payload, endpoint, method, contentType)
Name |
Type |
Description |
payload |
object |
Payload we want to validate |
endpoint |
string |
OpenApi endpoint we want to validate |
method |
string |
OpenApi method we want to validate |
contentType |
string |
Content api of the request we want to validate. Optional |
validateResponse(payload, endpoint, method, status, contentType)
Name |
Type |
Description |
payload |
object |
Payload we want to validate |
endpoint |
string |
OpenApi endpoint we want to validate |
method |
string |
OpenApi method we want to validate |
status |
string |
OpenApi status we want to validate |
contentType |
string |
Content api of the request we want to validate. Optional |
validateRequiredValues(values, endpoint, method)
Name |
Type |
Description |
values |
object |
Values we want to check if they are required |
endpoint |
string |
OpenApi endpoint we want to validate |
method |
string |
OpenApi method we want to validate |
isRequestRequired(endpoint, method, contentType)
Name |
Type |
Description |
endpoint |
string |
OpenApi endpoint we want to validate |
method |
string |
OpenApi method we want to validate |
contentType |
string |
Content api of the request we want to validate. Optional |