Schema definitions in Rest API - Step-by-Step Execution

Concept Flow - Schema definitions

Define Data Structure

↓

Specify Field Names

↓

Set Field Types

↓

Add Validation Rules

↓

Use Schema to Validate Data

↓

Accept or Reject Data

This flow shows how a schema defines data structure, sets field types and rules, then validates incoming data.

Execution Sample

Rest API

schema = {
  "name": "string",
  "age": "integer",
  "email": "string"
}

def validate(data, schema):
    for field, field_type in schema.items():
        if field not in data:
            return False
        if field_type == "string" and not isinstance(data[field], str):
            return False
        if field_type == "integer" and not isinstance(data[field], int):
            return False
    return True

# Example usage

data = {"name": "Alice", "age": 30, "email": "[e-mail]"}
validate(data, schema)

Defines a simple schema with name, age, email fields and validates data against it.

Execution Table

Step	Action	Field	Expected Type	Data Value	Validation Result
1	Check field	name	string	"Alice"	Pass
2	Check field	age	integer	30	Pass
3	Check field	email	string	"[e-mail]"	Pass
4	All fields valid?	-	-	-	Yes - Data Accepted

💡 All fields match expected types, so data passes schema validation.

Variable Tracker

Variable	Start	After 1	After 2	After 3	Final
data	{"name": "Alice", "age": 30, "email": "[e-mail]"}	Checked name	Checked age	Checked email	Validated
validation_result	None	Pass	Pass	Pass	All Pass

Key Moments - 2 Insights

Why must the data type match the schema exactly?

Because the schema defines expected types (see execution_table rows 1-3). If types differ, validation fails and data is rejected.

What happens if a field is missing in the data?

The validation will fail because the schema expects all defined fields (not shown in this example but implied in step 4).

Visual Quiz - 3 Questions

Look at the execution_table, what is the validation result for the 'age' field?

A Fail

B Pass

C Skipped

D Error

💡 Hint

Check execution_table row 2 under Validation Result column.

At which step does the schema confirm all fields are valid?

A Step 4

B Step 2

C Step 3

D Step 1

💡 Hint

Look at the last row in execution_table where all fields are checked.

If the 'email' field was a number instead of a string, what would happen?

A Validation would pass

B Validation would fail at step 1

C Validation would fail at step 3

D Validation would skip the email field

💡 Hint

Refer to execution_table row 3 where 'email' type is checked.

Concept Snapshot

Schema definitions set the expected structure and types for data.
Each field has a name and a type.
Data is checked field-by-field against the schema.
If all fields match, data is accepted.
If any field mismatches or is missing, data is rejected.

Full Transcript

Schema definitions are like blueprints for data. You first define what fields you expect, like name, age, and email. Each field has a type, such as string or integer. When data comes in, the schema checks each field to see if it matches the expected type. If all fields match, the data is accepted. If any field is missing or has the wrong type, the data is rejected. This process helps keep data clean and predictable.

Practice

1. What is the main purpose of a schema definition in a REST API?

easy

A. To improve the speed of the API response

B. To store user login information securely

C. To handle server errors automatically

D. To describe the structure and rules of the data exchanged

Solution

1. Step 1: Understand what schema definitions do

   Schema definitions specify how data should look and what rules it must follow in an API.

2. Step 2: Match purpose with options

   Only To describe the structure and rules of the data exchanged correctly states that schemas describe data structure and rules.

3. Final Answer:

   To describe the structure and rules of the data exchanged -> Option D

4. Quick Check:

   Schema = Data structure and rules [OK]

Hint: Schemas define data shape and rules in APIs [OK]

Common Mistakes:

• Confusing schema with security features
• Thinking schema speeds up API
• Assuming schema handles errors

2. Which of the following is the correct way to define a simple string property called name in an OpenAPI schema?

easy

A. name: string

B. name: { type: 'string' }

C. name: 'string' type

D. name: { string: true }

Solution

1. Step 1: Recall OpenAPI property syntax

   Properties are defined as key-value pairs with a type inside an object, e.g., name: { type: 'string' }.

2. Step 2: Compare options

   Only name: { type: 'string' } matches the correct syntax for defining a string property.

3. Final Answer:

   name: { type: 'string' } -> Option B

4. Quick Check:

   Property syntax = key: { type: 'string' } [OK]

Hint: Use key: { type: 'string' } for string properties [OK]

Common Mistakes:

• Writing type outside an object
• Using plain string without type key
• Confusing property name with type

3. Given this OpenAPI schema snippet, what is the type of the age property?

components:
  schemas:
    User:
      type: object
      properties:
        age:
          type: integer
          minimum: 0

medium

A. integer

B. string

C. boolean

D. array

Solution

1. Step 1: Read the schema property definition

   The age property is defined with type: integer and a minimum value of 0.

2. Step 2: Identify the data type

   The type clearly states integer, meaning whole numbers only.

3. Final Answer:

   integer -> Option A

4. Quick Check:

   age type = integer [OK]

Hint: Look for 'type' key to find property data type [OK]

Common Mistakes:

• Assuming age is string by default
• Confusing integer with boolean
• Ignoring the type key

4. Identify the error in this JSON schema snippet for a REST API:

{
  "type": "object",
  "properties": {
    "id": { "type": "integer" },
    "email": { "type": "string", "format": "email" },
    "active": "boolean"
  },
  "required": ["id", "email"]
}

medium

A. "id" property type should be string

B. "required" must include "active"

C. "active" property should be an object with a type key

D. Missing comma after "email" property

Solution

1. Step 1: Check property definitions

   Each property must be an object with a "type" key. "active" is given as a string "boolean" instead of an object.

2. Step 2: Validate other parts

   "id" type integer is correct, "required" does not need "active", and commas are correctly placed.

3. Final Answer:

   "active" property should be an object with a type key -> Option C

4. Quick Check:

   Property format = object with type key [OK]

Hint: Properties must be objects with type keys, not strings [OK]

Common Mistakes:

• Writing property types as strings directly
• Forgetting to wrap property details in objects
• Assuming required means all properties

5. You want to define a schema for a REST API response that returns a list of users, where each user has a username (string) and roles (array of strings). Which schema snippet correctly represents this?

hard

A. type: object
properties:
users:
type: array
items:
type: object
properties:
username:
type: string
roles:
type: array
items:
type: string

B. type: array
items:
type: object
properties:
username: string
roles: array of strings

C. type: object
properties:
users:
type: object
properties:
username: string
roles: string

D. type: array
items:
type: string
properties:
username: string
roles: array

Solution

1. Step 1: Understand the data structure

   The response is an object with a "users" property that is an array of user objects.

2. Step 2: Check each user object schema

   Each user has "username" as string and "roles" as an array of strings, so nested arrays and objects are needed.

3. Step 3: Match with options

   Only type: object properties: users: type: array items: type: object properties: username: type: string roles: type: array items: type: string correctly nests arrays and objects with proper types and keys.

4. Final Answer:

   type: object properties: users: type: array items: type: object properties: username: type: string roles: type: array items: type: string -> Option A

5. Quick Check:

   Nested arrays and objects = type: object properties: users: type: array items: type: object properties: username: type: string roles: type: array items: type: string [OK]

Hint: Use nested objects and arrays for complex data shapes [OK]

Common Mistakes:

• Writing array items as plain strings
• Confusing object and array types
• Missing nested items key for arrays