Overview of JSON Schema And Payload Size Validation Connector
Release Notes
| API Management (Release Date) | Release Type | Release Description |
|---|---|---|
| October 1, 2020 | New Feature | Support RESTful API request validation using JSON schema provided either in Content Type header or Link header. |
| Also supports RESTful API payload size validation. | ||
| Optionally supports fail-safe mode for payload size validation. In fail-safe true mode API calls are forwarded even it is more than configured max size but less than max allowed payload size. Refer to Usage section. | ||
Support configuration override_custom_error_message for enabling API service endpoint supported static custom messages to override Connector runtime message. |
Description
-
The connector blocks incoming RESTful API requests that fail schema validation against the given JSON schema.
-
The connector also blocks incoming API requests based on the configured
max_payload_size. If the incoming request payload exceeds the configuredpayload-max-size, the API request is blocked, and the connector returns an error message. -
The connector validates JSON response against the JSON schema, and if it fails, it blocks the response and responds with an error message.
-
The connector also blocks responses from the backend based on
max_payload_size. If the response payload exceeds the configuredpayload-max-size, the connector returns an error message. -
Supports pre-processing of API request and post-processing of backend server response.