Schema validation basics in Postman

Introduction

Schema validation helps check if the data you get matches the expected format. It makes sure your app works with correct and complete data.

When testing an API response to confirm it has all required fields.

When verifying that data types in a response are correct, like numbers or strings.

When checking if optional fields are present or absent as expected.

When ensuring nested objects or arrays in the response follow the right structure.

When automating tests to catch changes in API response format early.

Syntax

Postman

pm.test('Validate response schema', () => {
  const schema = {
    type: 'object',
    properties: {
      id: { type: 'number' },
      name: { type: 'string' },
      active: { type: 'boolean' }
    },
    required: ['id', 'name', 'active']
  };
  pm.response.to.have.jsonSchema(schema);
});

Use pm.response.to.have.jsonSchema(schema) to check the response matches the schema.

The schema follows JSON Schema standards to describe expected data types and required fields.

Examples

This example checks that the response has a userId as a number and username as a string, both required.

Postman

const schema = {
  type: 'object',
  properties: {
    userId: { type: 'number' },
    username: { type: 'string' }
  },
  required: ['userId', 'username']
};
pm.test('User schema validation', () => {
  pm.response.to.have.jsonSchema(schema);
});

This example validates that the response is an array of objects, each with an id and title.

Postman

const schema = {
  type: 'array',
  items: {
    type: 'object',
    properties: {
      id: { type: 'number' },
      title: { type: 'string' }
    },
    required: ['id', 'title']
  }
};
pm.test('Posts array schema validation', () => {
  pm.response.to.have.jsonSchema(schema);
});

Sample Program

This test checks that the API response for a product has all required fields with correct types.

Postman

pm.test('Validate product response schema', () => {
  const productSchema = {
    type: 'object',
    properties: {
      productId: { type: 'number' },
      productName: { type: 'string' },
      price: { type: 'number' },
      inStock: { type: 'boolean' }
    },
    required: ['productId', 'productName', 'price', 'inStock']
  };
  pm.response.to.have.jsonSchema(productSchema);
});

Important Notes

Always define required fields to catch missing data early.

JSON Schema supports many data types and formats; use them to make your tests precise.

If the schema validation fails, Postman test will show which part of the response did not match.

Summary

Schema validation checks if response data matches expected structure and types.

Use Postman's pm.response.to.have.jsonSchema() for easy validation.

Defining clear schemas helps catch errors and keeps API responses reliable.

Practice

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

easy

A. To check if the server is online

B. To measure the response time of an API

C. To verify the API endpoint URL is correct

D. To check if the response data matches the expected structure and data types

Solution

1. Step 1: Understand schema validation concept

   Schema validation ensures the response data structure and types match what is expected.

2. Step 2: Compare options with schema validation purpose

   Only To check if the response data matches the expected structure and data types describes checking data structure and types, which is the core of schema validation.

3. Final Answer:

   To check if the response data matches the expected structure and data types -> Option D

4. Quick Check:

   Schema validation = check structure and types [OK]

Hint: Schema validation checks data shape and types [OK]

Common Mistakes:

• Confusing schema validation with performance testing
• Thinking schema validation checks URL correctness
• Assuming schema validation checks server status

2. Which Postman assertion syntax correctly validates a JSON response against a schema stored in schema variable?

easy

A. pm.response.to.have.jsonSchema(schema);

B. pm.response.to.have.schemaJson(schema);

C. pm.response.has.jsonSchema(schema);

D. pm.response.to.have.jsonSchemaCheck(schema);

Solution

1. Step 1: Recall correct Postman syntax for schema validation

   The correct method is pm.response.to.have.jsonSchema(schema); to validate JSON schema.

2. Step 2: Check each option for syntax correctness

   Only pm.response.to.have.jsonSchema(schema); matches the exact Postman syntax; others are invalid method names.

3. Final Answer:

   pm.response.to.have.jsonSchema(schema); -> Option A

4. Quick Check:

   Correct method = jsonSchema() [OK]

Hint: Use pm.response.to.have.jsonSchema(schema) exactly [OK]

Common Mistakes:

• Using incorrect method names like jsonSchemaCheck
• Mixing up method chaining order
• Omitting 'to.have' in the assertion

3. Given this schema snippet in Postman test script:

{
  "type": "object",
  "properties": {
    "id": {"type": "integer"},
    "name": {"type": "string"}
  },
  "required": ["id", "name"]
}

What will happen if the API response is {"id": 10, "name": "Alice"}?

medium

A. The schema validation will fail because 'id' is not a string

B. The schema validation will pass successfully

C. The schema validation will fail because 'name' is missing

D. The schema validation will fail due to missing required fields

Solution

1. Step 1: Analyze the schema requirements

   The schema expects an object with 'id' as integer and 'name' as string, both required.

2. Step 2: Compare the response with schema

   The response has 'id' as 10 (integer) and 'name' as "Alice" (string), satisfying all requirements.

3. Final Answer:

   The schema validation will pass successfully -> Option B

4. Quick Check:

   Response matches schema types and required fields [OK]

Hint: Match response types exactly to schema required fields [OK]

Common Mistakes:

• Confusing integer with string type
• Assuming missing fields when all are present
• Ignoring required fields in schema

4. You wrote this Postman test to validate a response schema:

const schema = {
  type: "object",
  properties: {
    age: { type: "integer" }
  },
  required: ["age"]
};
pm.test("Schema is valid");
pm.response.to.have.jsonSchema(schema);

But the test always fails even when the response has an integer age. What is the likely error?

medium

A. The assertion should be inside pm.test callback, but the code uses pm.test incorrectly

B. The test function is named pm.test but should be pm.response.test

C. Using pm.test instead of pm.response.to.have.jsonSchema

D. The assertion is inside pm.test but the function name is misspelled as pm.test

Solution

1. Step 1: Check the test function usage

   The correct syntax is pm.test("name", () => { assertion }); but the code calls pm.test("Schema is valid"); without the required callback function.

2. Step 2: Check assertion placement

   The assertion pm.response.to.have.jsonSchema(schema); is outside the pm.test callback and will not be properly associated with the test.

3. Final Answer:

   The assertion should be inside pm.test callback, but the code uses pm.test incorrectly -> Option A

4. Quick Check:

   pm.test requires callback containing assertion [OK]

Hint: Always wrap assertions in pm.test("name", () => { ... }) [OK]

Common Mistakes:

• Calling assertions directly without pm.test wrapper
• Misspelling pm.test or using wrong test function
• Not wrapping assertion inside pm.test callback

5. You want to validate an API response that returns a list of user objects, each with id (integer) and optional email (string). Which JSON schema correctly validates this response array?

hard

A. {
"type": "array",
"properties": {
"id": {"type": "integer"},
"email": {"type": "string"}
},
"required": ["id"]
}

B. {
"type": "object",
"properties": {
"id": {"type": "integer"},
"email": {"type": "string"}
},
"required": ["id"]
}

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

D. {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {"type": "string"},
"email": {"type": "string"}
},
"required": ["id", "email"]
}
}

Solution

1. Step 1: Identify the response type

   The response is an array of user objects, so schema type must be "array" with "items" describing each object.

2. Step 2: Check object properties and requirements

   Each object must have "id" as integer (required) and "email" as optional string (not required).

3. Step 3: Validate options against requirements

   { "type": "array", "items": { "type": "object", "properties": { "id": {"type": "integer"}, "email": {"type": "string"} }, "required": ["id"] } } correctly defines an array with items as objects, "id" integer required, "email" string optional. Others either define object instead of array, wrong types, or require "email".

4. Final Answer:

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

5. Quick Check:

   Array of objects with required id integer and optional email string [OK]

Hint: Use "type": "array" with "items" for object schema [OK]

Common Mistakes:

• Defining response as object instead of array
• Marking optional fields as required
• Using wrong data types for properties