Methods

IsRequestRequired(endpoint, method, contentType)

Parameters:

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

validate(openApiDef, options) → {ValidatorMethods}

Validate method

Parameters:

Name	Type	Description
openApiDef	object	OpenAPI definition
options	object	Options to extend the errorHandler or Ajv configuration

Returns:

ValidatorMethods - validator methods

ValidateParams(value, endpoint, method, contentType)

Parameters:

Name	Type	Description
value	*	Value 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

ValidateRequest(value, endpoint, method, contentType)

Parameters:

Name	Type	Description
value	*	Value 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

ValidateRequiredValues(value, endpoint, method)

Parameters:

Name	Type	Description
value	*	Values we want to see if are send as required parameters
endpoint	string	OpenApi endpoint we want to validate
method	string	OpenApi method we want to validate

ValidateResponse(value, endpoint, method, status, contentType)

Parameters:

Name	Type	Description
value	*	Value 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

Type Definitions

ValidatorMethods

Validator methods

Properties:

Name	Type	Description
validateRequest	ValidateRequest
validateQueryParam	ValidateParams
validatePathParam	ValidateParams
validateHeaderParam	ValidateParams
validateResponse	ValidateResponse
isRequestRequired	IsRequestRequired
validateRequiredValues	ValidateRequiredValues