【Spring Boot】Gradleプロジェクトを作成してHello Worldと表示するREST APIを実行する

Spring Bootの新規プロジェクトをGradleで作成して、Hello Worldと出力するREST APIを作成します。

Springの公式ページにクイックスタートガイドがあったのですが、Mavenプロジェクトでした。

Spring | Quickstart

Level up your Java code and explore what Spring can do for you.

そこで、Gradleでプロジェクトを作る場合のやり方を説明します。

Gradleプロジェクトの作成

start.spring.ioにて、Webプロジェクトの作成ができます。

Gradleのプロジェクトを作成するので、設定値は次のようにしました。

Project: Gradle Project
Language: Java
Spring Boot: 2.6.2
Project Metadata: PackagingをWar、そのほかはデフォルト

“GENERATE ⌘ + ↩︎”をクリックすると、プロジェクトのzipファイルがダウンロードされます。
zipファイルを回答して、プロジェクトのディレクトリをお使いのIDEで開いてください。

コードの修正

src/main/java/com/example/demoにあるDemoApplication.javaを書き換えて、REST APIで”Hello World”と出力するようにします。

package com.example.demo;

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

@SpringBootApplication
@RestController
public class DemoApplication {

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

	@GetMapping("/hello")
	public String hello(@RequestParam(value = "name", defaultValue = "World") String name) {
		return String.format("Hello %s!", name);
	}
}

これで、http://localhost:8080/helloをブラウザで開くと”Hello World”が表示され、クエリパラメタに?name=Taroと指定すれば、”Hello Taro”と表示されます。

Gradleで実行

プロジェクトではGradleラッパーを使用するので、Gradleをインストールする必要はありません。

.
├── gradlew
├── gradlew.bat
└── gradle
        └── wrapper
             ├── gradle-wrapper.jar
             └── gradle-wrapper.properties

バッチスクリプトとシェルスクリプトを使用して、インストールせずにGradleで実行できます。

Spring Bootを起動するには、ターミナルで次のコマンドを実行します。

 ./gradlew bootRun

実行したら、http://localhost:8080/helloをブラウザで開いてみましょう。

“Hello World!”と表示されればOKです。

クエリパラメタでnameを指定すると、Worldの箇所が指定した文字列に変わります。

指定の仕方はこんな感じ
→http://localhost:8080/hello?name=Taro

止めるときはターミナルでCtrl + Cです。

以上。