0Pricing
GraphQL APIs with Spring Boot · Урок

Использование входных типов для мутаций

Упрощайте аргументы мутаций, определяя повторно используемые входные типы для более чистых и организованных вызовов API.

«Использование входных типов для мутаций» — бесплатный урок GraphQL APIs with Spring Boot на CoddyKit. Это урок 3 из 4. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения GraphQL APIs with Spring Boot, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс GraphQL APIs with Spring Boot содержит 4 уроков всего.

Части этого урока еще не переведены и отображаются на английском.

Long Mutation Arguments?

When building GraphQL mutations, you often need to pass several pieces of data to create or update an entity. Think about creating a new user or a product.

Passing each field as a separate argument can make your mutation signatures quite long and hard to manage, leading to less readable and maintainable code.

Meet GraphQL Input Types

Input types are special object types in GraphQL used specifically as arguments for mutations (or sometimes queries). They allow you to group related fields into a single, structured object.

This makes your mutation definitions cleaner and more organized, similar to how a DTO (Data Transfer Object) works in traditional REST APIs.

Input Type Syntax (SDL)

Defining an input type in your GraphQL Schema Definition Language (SDL) is straightforward. You use the input keyword instead of type.

Input types can only contain scalar types, enums, or other input types as their fields. They cannot contain output object types, interfaces, or union types.

input CreateProductInput {
  name: String!
  description: String
  price: Float!
  category: String
}

The Problem: Many Arguments

Consider a mutation to create a new product. Without an input type, you might define it like this:

Notice how the argument list can become long and repetitive, especially if you have many fields. This can be cumbersome to write and read.

type Mutation {
  createProduct(
    name: String!,
    description: String,
    price: Float!,
    category: String
  ): Product
}

The Solution: Clean Mutations

By using our CreateProductInput, the mutation signature becomes much cleaner and easier to read. All related input fields are now encapsulated within a single argument.

This improves clarity and reduces clutter in your schema.

type Mutation {
  createProduct(input: CreateProductInput!): Product
}

input CreateProductInput {
  name: String!
  description: String
  price: Float!
  category: String
}

Spring Boot DTO for Input

In your Spring Boot application, you'll represent your GraphQL input types as simple Java classes. These act as Data Transfer Objects (DTOs) that Spring's GraphQL integration can automatically map for you.

Ensure the field names in your Java class match your SDL input type for seamless mapping.

package com.coddykit.graphql;

public class CreateProductInput {
    private String name;
    private String description;
    private float price;
    private String category;

    // Getters and Setters (omitted for brevity)
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    // ... other getters/setters
}

Using Input in Resolver

Now, let's see how your GraphQL resolver method in Spring Boot will use this CreateProductInput DTO. Instead of multiple @Argument annotations, you'll have just one for your input object.

This makes the resolver method signature much cleaner and easier to manage, especially with many input fields.

package com.coddykit.graphql;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.graphql.data.method.annotation.Argument;
import org.springframework.graphql.data.method.annotation.MutationMapping;
import org.springframework.stereotype.Controller;

// Dummy Product class for example return type
class Product {
    String id; String name; public Product(String id, String name) { this.id = id; this.name = name; } 
    public String getId() { return id; } public String getName() { return name; }
}

// Input DTO from previous scene
class CreateProductInput {
    private String name; private String description; private float price; private String category;
    public String getName() { return name; } public void setName(String name) { this.name = name; }
    public String getDescription() { return description; } public void setDescription(String description) { this.description = description; }
    public float getPrice() { return price; } public void setPrice(float price) { this.price = price; }
    public String getCategory() { return category; } public void setCategory(String category) { this.category = category; }
}

@SpringBootApplication
@Controller
public class Main {

    public static void main(String[] args) {
        // This would start a Spring Boot web server
        // SpringApplication.run(Main.class, args);
        System.out.println("Application context started (conceptually).");
    }

    private static long productIdCounter = 1;

    @MutationMapping
    public Product createProduct(@Argument CreateProductInput input) {
        System.out.println("Creating product: " + input.getName());
        // In a real application, you'd save this to a database
        String newId = "prod-" + productIdCounter++;
        return new Product(newId, input.getName());
    }
}

Why Use Input Types?

Input types offer several significant advantages for your GraphQL API design:

  • Readability: Mutation signatures become much shorter and clearer.
  • Reusability: The same input type can often be used for both creation and update mutations, reducing schema duplication.
  • Validation: It's easier to apply validation logic to a single, consolidated input object.
  • Extensibility: Adding new optional fields to an input type doesn't break existing clients, as they can simply ignore the new fields.

Complex Data with Nested Inputs

Input types can also contain other input types, allowing you to model complex, hierarchical data for your mutations. This is very powerful for structured data submission.

For example, when creating an order, you might need to include customer details and a list of items, each with its own properties, all within a single input object.

input AddressInput {
  street: String!
  city: String!
  zipCode: String
}

input CustomerInput {
  name: String!
  email: String!
  shippingAddress: AddressInput
}

input CreateOrderInput {
  customer: CustomerInput!
  items: [OrderItemInput!]!
}

input OrderItemInput {
  productId: ID!
  quantity: Int!
}

Input Types Check

You've learned about GraphQL Input Types and their benefits. Let's test your understanding!

Recap: Input Types Mastered!

Great job! In this lesson, you mastered GraphQL Input Types. You learned how they streamline mutation arguments, making your API cleaner and more maintainable.

  • We saw how to define input types in SDL using the input keyword.
  • Implemented them in Spring Boot resolvers by using DTOs.
  • And explored their key benefits like improved readability, reusability, and easier validation.

These are essential for building robust and user-friendly GraphQL APIs! Keep practicing!

Часто задаваемые вопросы

Урок «Использование входных типов для мутаций» бесплатный?

Да — полный текст урока «Использование входных типов для мутаций» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс GraphQL APIs with Spring Boot, подпишись на CoddyKit PRO. Курс GraphQL APIs with Spring Boot содержит 4 уроков всего.

Чему я научусь в уроке «Использование входных типов для мутаций»?

Упрощайте аргументы мутаций, определяя повторно используемые входные типы для более чистых и организованных вызовов API. Ты практикуешь GraphQL APIs with Spring Boot с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.

Нужен ли мне опыт, чтобы начать GraphQL APIs with Spring Boot?

Предыдущий опыт не требуется. GraphQL APIs with Spring Boot на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 3 из 4.

Сколько времени занимает урок «Использование входных типов для мутаций»?

Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.

Можно ли писать и запускать код в этом уроке GraphQL APIs with Spring Boot?

Да. Каждый урок GraphQL APIs with Spring Boot включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.

Все уроки этого курса

  1. Моделирование вложенных объектов и связей
  2. Реализация интерфейсов и объединённых типов
  3. Использование входных типов для мутаций
  4. Перечисления и пользовательские скалярные типы
← Назад к GraphQL APIs with Spring Boot