0Pricing
Spring Boot 4 Complete Guide · レッスン

RESTコントローラーの作成

`@RestController`とさまざまなマッピングアノテーションを使って、RESTfulエンドポイントを設計・実装します。

「RESTコントローラーの作成」はCoddyKit上の無料Spring Boot 4 Complete Guideレッスンです。 これはレッスン1/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応の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コントローラーの作成」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Spring Boot 4 Complete Guideコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Spring Boot 4 Complete Guideコースには全4レッスンが含まれています。

「RESTコントローラーの作成」で何を学びますか？

`@RestController`とさまざまなマッピングアノテーションを使って、RESTfulエンドポイントを設計・実装します。 ブラウザで直接実行するハンズオンコードでSpring Boot 4 Complete Guideを演習し、24時間対応の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に戻る