Kotlin × Spring Boot で REST API の構築

こんにちは、白々さじきです!

今回は、Kotlin のチュートリアルを参考にして REST API を作成 してみました!
Spring Boot を使えば、簡単な API ならすぐに作れます!

それでは、早速やっていきましょう!

コントローラーの作成

まずは、Spring Boot のコントローラーを作成 していきます。

1. 新しい Kotlin クラスの作成

com.example.demo のフォルダを 右クリック → 新規 を選択し、Kotlin クラス を作成します。

作成するクラス名は、MessageController.ktです。

2. コードを追加する

作成した MessageController.kt に、チュートリアルにある import 文とクラスの中身 をコピーします。

最終的なコードは以下のようになります。

package com.example.demo

import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestParam
import org.springframework.web.bind.annotation.RestController

@RestController
class MessageController {
    @GetMapping("/")
    fun index(@RequestParam("name") name: String) = "Hello, $name!"
}

コードの解説

1. @RestController とは?

Spring Boot で Spring Boot の REST API を提供するコントローラー であることを示します。

2. @GetMapping("/") とは?

このアノテーションは、このメソッドが HTTP の GET リクエストを処理することを示すものです。
ここでは、ルートパス(http://localhost:8080/)にアクセス したときにこのメソッドが実行されます。

3. @RequestParam とは?

HTTP リクエストの クエリパラメータ(?name=〇〇)を取得するアノテーション です。

例えば、次のような URL にアクセスすると…

http://localhost:8080/?name=Taro

name の値(Taro)が 関数の引数として受け取られ、”Hello, Taro!” が返る ようになります。

アプリケーションの実行

作成した API を IntelliJ IDEA で実行 してみます!

1. Spring Boot の起動

前回と同様に、「Run」ボタン をクリックすると、Spring Boot が起動します。

起動ログ:

このように ルートパスが表示 されていれば、正しく起動できています! 🎉

2. API の動作確認

次に、ブラウザを使って、ローカルホスト(http://localhost:8080/?name=John)にアクセス してみます!

クエリパラメータなのでname=の部分を変更するとそれが反映されます。

このように、name に指定した値がメッセージに反映されるようになります!

感想

今回は、Kotlin × Spring Boot で REST API を実装 しました!

Spring Boot のアノテーションを活用することで、驚くほど簡単に REST API を作成できる のがわかりました!

次回は、データ型の作成 を試してみたいと思います!

それでは、また次回!

サポートのお願い

下記リンクからお買い物いただけると、ブログ運営のための費用が増え、有料サービスを利用した記事作成が可能になります。ご協力よろしくお願いします!

コメント

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