JSON Schema validation in Postman - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is JSON Schema validation?

JSON Schema validation is a way to check if a JSON response matches a defined structure and rules. It ensures the data format is correct.

beginner

How do you use JSON Schema validation in Postman tests?

In Postman, you write a test script that uses the 'pm.expect' function with 'tv4.validate' or 'ajv.validate' to check the response against a JSON schema.

beginner

What is the role of 'required' in a JSON Schema?

The 'required' keyword lists properties that must be present in the JSON data for the validation to pass.

beginner

Why is JSON Schema validation useful in API testing?

It helps catch errors early by verifying the API response structure, making sure the data is complete and correctly formatted.

beginner

What happens if JSON Schema validation fails in a Postman test?

The test will fail, showing an error message that the response does not match the expected schema.

Which keyword in JSON Schema specifies properties that must be present?

A required

B properties

C type

D items

The 'required' keyword lists the properties that must exist in the JSON data.

In Postman, which function is commonly used to assert JSON Schema validation?

A pm.sendRequest()

B console.log()

C pm.expect()

D pm.response.to()

pm.expect() is used to write assertions, including JSON Schema validation.

What does JSON Schema validation check in API responses?

A Server status

B Response structure and data types

C Response time

D Network latency

JSON Schema validation checks if the response structure and data types match the schema.

If a JSON Schema validation fails, what is the usual outcome in Postman?

A Response is ignored

B Test passes silently

C Postman crashes

D Test fails with an error

A failed validation causes the test to fail and shows an error message.

Which of these is NOT a valid JSON Schema data type?

A function

B integer

C boolean

D string

'function' is not a valid JSON Schema data type.

Explain how JSON Schema validation helps improve API testing in Postman.

Think about how validating the shape and content of data helps avoid bugs.

Describe the steps to add JSON Schema validation in a Postman test script.

Focus on writing the schema and using Postman test functions.

Practice

1. What is the main purpose of JSON Schema validation in Postman?

easy

A. To create new API endpoints

B. To speed up the API response time

C. To change the API response data automatically

D. To check if the API response data matches the expected format

Solution

1. Step 1: Understand JSON Schema validation role

   JSON Schema validation is used to verify that the data structure matches what is expected.

2. Step 2: Relate to Postman usage

   In Postman, it helps confirm the API response format is correct, catching errors early.

3. Final Answer:

   To check if the API response data matches the expected format -> Option D

4. Quick Check:

   JSON Schema validation = format check [OK]

Hint: Remember: JSON Schema validates data format, not speed or changes [OK]

Common Mistakes:

• Thinking it changes API data
• Confusing validation with performance
• Assuming it creates endpoints

2. Which of the following is the correct way to write a JSON Schema type check for a string in Postman test script?

easy

A. "type": "string"

B. "type": string

C. "type": 'string'

D. type: "string"

Solution

1. Step 1: Recall JSON Schema syntax for type

   JSON Schema requires property names and string values to be in double quotes.

2. Step 2: Check each option's syntax

   "type": "string" uses double quotes correctly for both key and value, matching JSON standards.

3. Final Answer:

   "type": "string" -> Option A

4. Quick Check:

   JSON keys and string values need double quotes [OK]

Hint: Use double quotes for keys and string values in JSON Schema [OK]

Common Mistakes:

• Omitting quotes around string values
• Using single quotes instead of double quotes
• Missing quotes around keys

3. Given this Postman test snippet, what will be the test result if the response JSON is {"name": "Alice", "age": 30}?

const schema = {
  type: "object",
  properties: {
    name: { type: "string" },
    age: { type: "integer" }
  },
  required: ["name", "age"]
};

pm.test("Validate response schema", () => {
  pm.response.to.have.jsonSchema(schema);
});

medium

A. Test fails because age is not a string

B. Test passes because response matches schema

C. Test fails because required fields are missing

D. Test fails due to syntax error in schema

Solution

1. Step 1: Compare response data types with schema

   Response has "name" as string and "age" as integer, matching schema types.

2. Step 2: Check required fields presence

   Both "name" and "age" are present in response, fulfilling required array.

3. Final Answer:

   Test passes because response matches schema -> Option B

4. Quick Check:

   Response matches schema = test passes [OK]

Hint: Match data types and required fields to schema for pass [OK]

Common Mistakes:

• Confusing integer with string type
• Ignoring required fields presence
• Assuming syntax error without checking

4. You wrote this JSON Schema in Postman test but the validation always fails:

const schema = {
  type: "object",
  properties: {
    id: { type: "number" },
    email: { type: "string" }
  },
  required: ["id", "email"]
};

pm.test("Check schema", () => {
  pm.response.to.have.jsonSchema(schema);
});

The API response is {"id": 123, "email": "[e-mail]"}. What is the likely problem?

medium

A. The type "number" should be "integer" for whole numbers

B. The required array should be outside the schema object

C. The response keys are missing quotes

D. The test syntax is incorrect

Solution

1. Step 1: Understand JSON Schema number vs integer types

   JSON Schema distinguishes "number" (any number) and "integer" (whole numbers). API returns whole number 123.

2. Step 2: Check if "number" type matches whole number

   "number" accepts integers generally, but Postman JSON Schema validation requires "integer" for whole numbers like 123.

3. Step 3: Consider common Postman issue

   Postman JSON Schema validation is strict; using "number" for integer values can cause mismatch.

4. Final Answer:

   The type "number" should be "integer" for whole numbers -> Option A

5. Quick Check:

   Use "integer" for whole numbers in schema [OK]

Hint: Use "integer" type for whole numbers in JSON Schema [OK]

Common Mistakes:

• Placing required outside schema
• Ignoring quotes in JSON keys (not relevant here)
• Assuming test syntax error without checking

5. You want to validate an API response in Postman where the "tags" field is an array of strings, but it can be empty or missing. Which JSON Schema snippet correctly allows this?

hard

A. {
"type": "object",
"properties": {
"tags": {
"type": ["array", "null"],
"items": { "type": "string" }
}
},
"required": []
}

B. {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["tags"]
}

C. {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": []
}

D. {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": { "type": "string" },
"minItems": 1
}
},
"required": []
}

Solution

1. Step 1: Understand optional field with empty array allowed

   The "tags" field can be missing or present as an empty array or array of strings.

2. Step 2: Analyze each option

   { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": [] } allows "tags" as array of strings, not required (can be missing). { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": ["tags"] } requires "tags" always. { "type": "object", "properties": { "tags": { "type": ["array", "null"], "items": { "type": "string" } } }, "required": [] } allows null type which is not needed. { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [] } requires at least one item (minItems:1), disallowing empty array.

3. Final Answer:

   { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "required": [] } -> Option C

4. Quick Check:

   Optional field with empty array = not required, no minItems [OK]

Hint: Use empty required array and no minItems for optional empty arrays [OK]

Common Mistakes:

• Making field required when optional
• Adding minItems disallowing empty arrays
• Allowing null when not needed