We have added a specification extension to OpenAPI specs that documents which responses to return when requests are invalid.
It allows your API consumers to understand in more detail what validation responses look like just by looking at the OpenAPI spec. It is handy for external APIs where talking directly to support might take time.
It also allows Traffic Parrot to generate API mocks that mimic those validation rules on the fly from just the OpenAPI spec without any need for coding. That means the API consumers have API mocks ready in milliseconds without any coding required!
For example, to validate the entire request and return a specific response object, you can add to your OpenAPI example:
x-traffic-parrot-validation:- type: schema
response:
code: INVALID_REQUEST
message: ${in} parameter ${name} has invalid value ${value} because ${reason}
We are adding more sophisticated rules to allow embedding even more details in the OpenAPI spec.
Comment below "Keep me posted!" if you want to hear more when ready!
