Input types in GraphQL

Introduction

Input types let you send data into GraphQL queries or mutations in a clear and organized way.

When you want to add new data to a database using a mutation.

When you need to update existing data with specific fields.

When you want to filter or search data by passing parameters.

When you want to keep your queries clean by grouping related inputs.

When you want to reuse the same input structure in multiple places.

Syntax

GraphQL

input InputName {
  field1: Type1
  field2: Type2
  ...
}

Input types are defined using the input keyword, not type.

Fields inside input types can only be scalars, enums, or other input types.

Examples

This input type defines a user with a required name and optional age and email.

GraphQL

input UserInput {
  name: String!
  age: Int
  email: String
}

This input type can be used to filter posts by title or published status.

GraphQL

input PostFilter {
  titleContains: String
  published: Boolean
}

Sample Program

This mutation uses an input type to create a new user with username, email, and optional age.

GraphQL

input NewUserInput {
  username: String!
  email: String!
  age: Int
}

mutation CreateUser($input: NewUserInput!) {
  createUser(input: $input) {
    id
    username
    email
    age
  }
}

Important Notes

Input types cannot have fields that are other object types, only input types or scalars.

Always mark required fields with ! to ensure they are provided.

Summary

Input types organize data sent into queries or mutations.

They help keep your API clean and reusable.

Use input keyword and only allowed field types.

Practice

1. What is the main purpose of input types in GraphQL?

easy

A. To define the shape of data sent into queries or mutations

B. To specify the output format of queries

C. To create database tables automatically

D. To style the API responses

Solution

1. Step 1: Understand the role of input types

   Input types define how data should be structured when sent to the server in queries or mutations.

2. Step 2: Differentiate input from output types

   Output types define what data is returned, while input types organize incoming data.

3. Final Answer:

   To define the shape of data sent into queries or mutations -> Option A

4. Quick Check:

   Input types = organize incoming data [OK]

Hint: Input types shape incoming data, not output [OK]

Common Mistakes:

• Confusing input types with output types
• Thinking input types create database tables
• Assuming input types affect response styling

2. Which of the following is the correct syntax to define an input type in GraphQL?

easy

A. input UserInput = { name: String!, age: Int }

B. type UserInput { name: String! age: Int }

C. input UserInput(name: String!, age: Int)

D. input UserInput { name: String! age: Int }

Solution

1. Step 1: Recall input type declaration syntax

   Input types use the keyword input followed by the name and curly braces for fields.

2. Step 2: Check each option's syntax

   input UserInput { name: String! age: Int } correctly uses input UserInput { ... }. type UserInput { name: String! age: Int } uses type which is for output types. Options C and D have invalid syntax.

3. Final Answer:

   input UserInput { name: String! age: Int } -> Option D

4. Quick Check:

   Input types start with 'input' keyword [OK]

Hint: Input types start with 'input' keyword and braces [OK]

Common Mistakes:

• Using 'type' instead of 'input'
• Using parentheses instead of braces
• Assigning input type with '=' sign

3. Given this input type:

input ProductInput { id: ID! name: String! price: Float }

Which mutation call is valid?

medium

A. mutation { addProduct(input: { name: "Pen", price: "1.5" }) { id name } }

B. mutation { addProduct(input: { id: 123, name: "Pen" }) { id name } }

C. mutation { addProduct(input: { id: "123", name: "Pen", price: 1.5 }) { id name } }

D. mutation { addProduct(input: { id: "123", price: 1.5 }) { id name } }

Solution

1. Step 1: Check required fields and types

   Fields id and name are required (non-null). price is optional. Types must match: id is ID (string), name is String, price is Float.

2. Step 2: Validate each option

   mutation { addProduct(input: { id: "123", name: "Pen", price: 1.5 }) { id name } } provides all required fields with correct types. mutation { addProduct(input: { id: 123, name: "Pen" }) { id name } } uses number 123 for ID (should be string). mutation { addProduct(input: { name: "Pen", price: "1.5" }) { id name } } misses required id and uses string for price (should be Float). mutation { addProduct(input: { id: "123", price: 1.5 }) { id name } } misses required name.

3. Final Answer:

   mutation { addProduct(input: { id: "123", name: "Pen", price: 1.5 }) { id name } } -> Option C

4. Quick Check:

   Required fields present with correct types [OK]

Hint: Required fields must be present with correct types [OK]

Common Mistakes:

• Omitting required fields
• Using wrong data types (e.g., number instead of string for ID)
• Passing strings for Float fields

4. Identify the error in this input type definition:

input UserInput { id: ID! name: String age: Int! }

medium

A. Syntax is correct; no error

B. Input types cannot have non-null fields

C. Missing commas between fields

D. Field names must be lowercase

Solution

1. Step 1: Review GraphQL input type syntax rules

   Input types list fields with their types separated by spaces or new lines; commas are not required.

2. Step 2: Check each option against syntax

   Input types cannot have non-null fields is false; non-null fields are allowed. Field names must be lowercase is false; field names can be camelCase or lowercase. Missing commas between fields is false; commas are optional. Syntax is correct; no error is true; the syntax is valid.

3. Final Answer:

   Syntax is correct; no error -> Option A

4. Quick Check:

   Input fields separated by spaces, commas optional [OK]

Hint: Commas are optional between fields in input types [OK]

Common Mistakes:

• Thinking commas are mandatory
• Believing non-null fields are disallowed
• Assuming field names must be lowercase only

5. You want to create an input type for updating a user's profile where all fields are optional except id. Which input type definition is correct?

hard

A. input UpdateUserInput { id: ID! name: String! email: String age: Int }

B. input UpdateUserInput { id: ID! name: String email: String age: Int }

C. input UpdateUserInput { id: ID! name: String! email: String! age: Int! }

D. input UpdateUserInput { id: ID name: String! email: String! age: Int! }

Solution

1. Step 1: Understand requirement for optional fields

   Only id must be required (non-null). Other fields should be optional, so no exclamation marks.

2. Step 2: Evaluate each option

   input UpdateUserInput { id: ID! name: String email: String age: Int } has id: ID! required and others optional. input UpdateUserInput { id: ID name: String! email: String! age: Int! } makes id optional and others required, wrong. input UpdateUserInput { id: ID! name: String! email: String! age: Int! } makes all fields required, wrong. input UpdateUserInput { id: ID! name: String! email: String age: Int } makes name required, which is not desired.

3. Final Answer:

   input UpdateUserInput { id: ID! name: String email: String age: Int } -> Option B

4. Quick Check:

   Only id required, others optional [OK]

Hint: Only add '!' to required fields in input types [OK]

Common Mistakes:

• Making all fields required
• Forgetting to make id required
• Adding '!' to optional fields