0Pricing
Spring Boot 4 Complete Guide · Урок

Создание REST-контроллеров

Проектируйте и реализуйте конечные точки RESTful с помощью `@RestController` и различных аннотаций сопоставления

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

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

Welcome to REST Controllers!

You're about to dive into building powerful web services with Spring Boot! Today, we'll learn how to create RESTful APIs, which are the backbone of modern web applications.

Think of a REST API as a standard way for different computer systems to talk to each other over the internet.

What are RESTful APIs?

REST stands for REpresentational State Transfer. It's an architectural style for networked applications.

  • Resources: Everything is a resource (e.g., a user, a product).
  • Unique Identifiers: Each resource has a unique URL (e.g., /users/123).
  • Standard Methods: We use standard HTTP methods like GET, POST, PUT, DELETE to interact with resources.

Spring Boot makes implementing these a breeze!

Introducing `@RestController`

In Spring Boot, the @RestController annotation is key to building RESTful web services. It's a special type of Spring component.

  • It tells Spring that this class handles incoming web requests.
  • It combines @Controller and @ResponseBody.

@ResponseBody means the return value of your methods should be directly bound to the web response body.

Your First GET Endpoint

Let's create a simple endpoint that responds to a GET request. GET requests are used to retrieve data.

We use the @GetMapping annotation to map HTTP GET requests to specific handler methods.

Runnable GET Example

Try running this simple Spring Boot application. It defines a /hello endpoint that returns a greeting.

package com.coddykit;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class MyApplication {
  public static void main(String[] args) {
    SpringApplication.run(MyApplication.class, args);
  }
}

@RestController
class HelloController {
  @GetMapping("/hello")
  public String sayHello() {
    return "Hello from CoddyKit!";
  }
}

Testing Your GET Endpoint

After running the previous code, your Spring Boot application starts on port 8080 by default.

You can access your new endpoint by opening a web browser and navigating to:

  • http://localhost:8080/hello

You should see the message "Hello from CoddyKit!" displayed.

Introducing `@PostMapping`

While GET is for retrieving data, POST requests are typically used to create new resources on the server.

The @PostMapping annotation maps HTTP POST requests to a specific method. When you send data, it often comes in the 'request body'.

We use @RequestBody to tell Spring to convert the incoming body into a Java object (or a simple String).

Runnable POST Example

Let's add a POST endpoint to our existing controller. This endpoint will accept a name in the request body and return a personalized greeting.

package com.coddykit;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class MyApplication {
  public static void main(String[] args) {
    SpringApplication.run(MyApplication.class, args);
  }
}

@RestController
class HelloController {
  @GetMapping("/hello")
  public String sayHello() {
    return "Hello from CoddyKit!";
  }

  @PostMapping("/greet")
  public String greetUser(@RequestBody String name) {
    return "Hello, " + name + "!";
  }
}

Path Variables with `@PathVariable`

Sometimes, you want to extract a value directly from the URL path itself. This is where path variables come in handy.

The @PathVariable annotation allows you to bind a URL template variable to a method parameter.

  • Example URL: /users/123
  • Here, 123 is a path variable representing a user ID.

Using Path Variables in Code

This example adds an endpoint that uses a path variable to greet a specific person whose name is part of the URL.

package com.coddykit;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class MyApplication {
  public static void main(String[] args) {
    SpringApplication.run(MyApplication.class, args);
  }
}

@RestController
class HelloController {
  @GetMapping("/hello")
  public String sayHello() {
    return "Hello from CoddyKit!";
  }

  @PostMapping("/greet")
  public String greetUser(@RequestBody String name) {
    return "Hello, " + name + "!";
  }

  @GetMapping("/greet/{name}")
  public String greetPathVar(@PathVariable String name) {
    return "Greetings, " + name + " from path!";
  }
}

Quick Check: Controller Basics

You've learned about `@RestController` and basic mapping annotations. Let's test your understanding.

Recap: Creating REST Controllers

Great job! You've taken your first steps into building RESTful APIs with Spring Boot:

  • We understood what RESTful APIs are and their purpose.
  • We learned about the fundamental @RestController annotation.
  • You implemented and tested endpoints for GET requests using @GetMapping.
  • You also created a basic POST endpoint with @PostMapping and used @RequestBody.
  • Finally, you saw how to extract dynamic data from URLs using @PathVariable.

Next, we'll dive deeper into handling various HTTP requests and crafting responses!

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

Урок «Создание REST-контроллеров» бесплатный?

Да — полный текст урока «Создание REST-контроллеров» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс Spring Boot 4 Complete Guide, подпишись на CoddyKit PRO. Курс Spring Boot 4 Complete Guide содержит 4 уроков всего.

Чему я научусь в уроке «Создание REST-контроллеров»?

Проектируйте и реализуйте конечные точки RESTful с помощью `@RestController` и различных аннотаций сопоставления Ты практикуешь Spring Boot 4 Complete Guide с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.

Нужен ли мне опыт, чтобы начать Spring Boot 4 Complete Guide?

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

Сколько времени занимает урок «Создание REST-контроллеров»?

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

Можно ли писать и запускать код в этом уроке Spring Boot 4 Complete Guide?

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

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

  1. Создание REST-контроллеров
  2. Обработка HTTP-запросов и ответов
  3. Проверка входных данных и обработка ошибок
  4. Документирование REST-программных интерфейсов с OpenAPI и Swagger
← Назад к Spring Boot 4 Complete Guide