Schema definitions in Rest API - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a schema definition in REST API?

A schema definition describes the structure and format of data exchanged in a REST API, like what fields exist and their types.

beginner

Why are schema definitions important in REST APIs?

They ensure both the server and client agree on data format, helping avoid errors and making communication clear.

beginner

Name a common format used for schema definitions in REST APIs.

JSON Schema is a popular format to define the structure, required fields, and data types for JSON data in REST APIs.

beginner

What does a schema definition typically include?

It usually includes field names, data types (like string or number), which fields are required, and sometimes example values.

intermediate

How does schema validation help in REST APIs?

Schema validation checks if the data sent or received matches the schema, catching mistakes early and improving reliability.

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

A To describe the data structure and format

B To style the API response

C To store user credentials

D To manage server hardware

Schema definitions describe the data structure and format for communication in REST APIs.

Which format is commonly used for schema definitions in REST APIs?

A JSON Schema

B HTML

C CSS

D SQL

JSON Schema is widely used to define data structures in REST APIs.

What does schema validation check in REST APIs?

A If the API key is valid

B If data matches the schema format

C If the client has internet

D If the server is online

Schema validation ensures data matches the expected structure and types.

Which of these is NOT typically part of a schema definition?

A Field data types

B Required fields

C Server IP address

D Field names

Server IP address is not part of schema definitions; schemas focus on data structure.

Why should clients and servers agree on a schema?

A To encrypt data

B To speed up the internet

C To reduce server costs

D To avoid data errors and misunderstandings

Agreeing on a schema prevents errors by ensuring both sides understand the data format.

Explain what a schema definition is and why it matters in REST APIs.

Think about how two friends agree on what to expect in a message.

Describe the key parts you would include when creating a schema definition for a REST API.

Imagine writing a form that tells what information is needed and how it should look.

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