@RestControllerの使い方と引数を徹底解説！【初心者向け】

こんにちは！今回は、Spring FrameworkでWebアプリケーションを作成する際に重要な役割を果たすアノテーション、@RestControllerについて詳しく解説します。このアノテーションを使うことで、RESTfulなWebサービスを簡単に構築できます。

@RestControllerとは？

@RestControllerは、Spring MVCでRESTful Webサービスを作成するための特別なコントローラクラスを示すアノテーションです。具体的には、次のような特徴があります：

  • 自動的にJSONに変換：@RestControllerを使うと、返却するオブジェクトが自動的にJSON形式に変換されます。
  • HTTPリクエストの処理：HTTPメソッド（GET、POST、PUT、DELETEなど）に応じたリクエストを処理するためのメソッドを定義できます。

このアノテーションを使うことで、APIを簡単に作成できるようになります。
（@Controllerと@ResponseBodyの組み合わせと同じ機能です。）

基本的な使い方

まずは、簡単な例を見てみましょう。ここでは、ユーザー情報を取得するAPIを作成します。

サーバー側のコード

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable Long id) {
        // ユーザー情報を取得する処理（仮の実装）
        return new User(id, "example@example.com");
    }
}

このコードでは、/users/{id}というURLに対してGETリクエストを処理するgetUserByIdメソッドを定義しています。リクエストで指定されたユーザーIDに基づいて、ユーザー情報を返します。

クライアント側のコード

APIを呼び出すために、以下のようにJavaScriptのfetchを使います。

fetch('http://localhost:8080/users/1')
    .then(response => response.json())
    .then(data => console.log(data));

このコードでは、指定したユーザーID（ここでは1）のユーザー情報を取得し、コンソールに表示します。

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "John Doe",
    "email": "john.doe@example.com"
}

返却するオブジェクトが自動的にJSON形式に変換されます。

@RestControllerの魅力

1. 簡単なJSON変換

@RestControllerを使うと、リターンするオブジェクトが自動的にJSON形式に変換されるため、特別な設定をする必要がありません。これにより、開発の効率が大幅に向上します。

2. シンプルなコーディング

通常のコントローラーと異なり、@ResponseBodyアノテーションを使わずに済むため、コードがシンプルになります。これにより、可読性が向上します。

3. 複数のHTTPメソッドに対応

@GetMapping、@PostMapping、@PutMapping、@DeleteMappingなどのアノテーションを組み合わせることで、異なるHTTPメソッドに対応したエンドポイントを簡単に作成できます。

具体的な応用例

ユーザー情報の作成

次に、ユーザーを新規作成するAPIを追加してみましょう。

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;

@RestController
public class UserController {

    @PostMapping("/users")
    public User createUser(@RequestBody User newUser) {
        // ユーザーをデータベースに保存する処理（仮の実装）
        return newUser; // 保存したユーザーを返す
    }
}

この例では、/usersに対してPOSTリクエストを受け取り、新しいユーザーを作成します。リクエストボディから受け取ったUserオブジェクトをそのまま返します。

ユーザー情報の更新

ユーザー情報を更新するAPIも追加できます。

import org.springframework.web.bind.annotation.PutMapping;

@RestController
public class UserController {

    @PutMapping("/users/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User updatedUser) {
        // ユーザー情報を更新する処理（仮の実装）
        return updatedUser; // 更新したユーザーを返す
    }
}

このコードでは、ユーザーIDに基づいて指定されたユーザー情報を更新し、更新したオブジェクトを返します。

おわりに

@RestControllerを使うことで、RESTfulなWebサービスを簡単に構築できます。これからAPI開発を行う際には、ぜひ活用してみてください！

もっと詳しく知りたい方は、Spring公式ドキュメントを見てみてくださいね。

他の記事が見たい方はこちら！↓↓↓

タイトルとURLをコピーしました