Skip to content

OpenAPI schema checks

When a collection has an OpenAPI spec, add a Body matches schema check and choose the response it should match, for example “List all pets · 200”.

A Body matches schema check listing where the response differs from the spec.

The check understands type, nullable, enum, const, required, additionalProperties, items, lengths and sizes, pattern, number ranges, multipleOf, allOf, anyOf, oneOf, not, and the formats date, date-time, email and uuid. It lists up to 20 problems, each as the path, what was expected, and what came back.

The spec is kept in the collection (.openapi.json). After Update from OpenAPI…, checks use the new spec at once.

See OpenAPI and Swagger for importing a spec.