openapi-validator-utils

This library expose some methods to validate request, parameters, headers and response based on your OpenAPI Json definition.

Methods

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

• Type

  ValidatorMethods

ValidatorMethods object

These are the object keys the validate method returns.

{
  validateRequest,
  validateQueryParam,
  validatePathParam,
  validateHeaderParam,
  validateResponse,
}

| Name | Type | Description | | --------------------------------------------|:--------:| ------------------:| | validateRequest | function | Method to validate an endpoint's request | | validateQueryParam | function | Method to validate an endpoint's query parameter | | validatePathParam | function | Method to validate an endpoint's path parameter | | validateHeaderParam | function | Method to validate an endpoint's header parameter | | validateResponse | function | Method to validate an endpoint's response | | validateRequiredValues | function | Method to required parameters | | isRequestRequired | function | Method to validate if requestBody is necessary |

validateRequest

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

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

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

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

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

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 |