0Pricing
Spring Boot 4 Complete Guide · 课时

创建 REST 控制器

使用 `@RestController` 和各种映射注解设计并实现 RESTful 端点。

创建 REST 控制器 是 CoddyKit 上的免费 Spring Boot 4 Complete Guide 课时。 这是第 1 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 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 控制器」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Spring Boot 4 Complete Guide 课程的其余内容，请升级到 CoddyKit PRO。 Spring Boot 4 Complete Guide 课程共包含 4 节课。

「创建 REST 控制器」这节课中我会学到什么？

使用 `@RestController` 和各种映射注解设计并实现 RESTful 端点。 你通过在浏览器中直接运行的动手代码来练习 Spring Boot 4 Complete Guide，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Spring Boot 4 Complete Guide 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Spring Boot 4 Complete Guide 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 1 节课，共 4 节。

「创建 REST 控制器」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Spring Boot 4 Complete Guide 课中编写并运行代码吗？

能。每节 Spring Boot 4 Complete Guide 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 创建 REST 控制器
  2. 处理 HTTP 请求与响应
  3. 输入验证与错误处理
  4. 使用 OpenAPI 和 Swagger 编写 REST API 文档
← 返回 Spring Boot 4 Complete Guide