Spring Bootを使用して、基本的なCRUD操作ができる簡単なREST APIを構築する方法を解説していきます。
本記事では、使用する環境・ツールの基本構築から、簡単な動作確認までを行います。
各HTTPメソッドを使用した動作について知りたい方は、次の記事を参考にしてください。
Spring Bootを使ったREST APIの基本構築から動作確認まで②
・Javaの基礎知識を持っている方
・Spring Bootを初めて触る方、もしくは少し触ったことがある方
・REST APIについて学びたい方
・Eclipse 2022（Pleiades All in One）
・Spring Boot 3.4.4
本記事で使用する環境・ツールについて、インストール手順を記載していきます。
統合開発環境であるEclipseに、日本語化やよく使用するプラグインを内包したものがPleiades All in Oneです。
手順
Spring Bootプロジェクトの雛形を生成するWebサービスで、ブラウザ上もしくはEclipse上で、ビルドツールやバージョン、成果物の情報を入力・選択して、アプリケーションの雛形を簡単に生成することが出来るサービスです。
本記事ではブラウザ上でアプリケーションの雛形を生成する方法について説明します。
手順
以上で初期セットアップは完了ですが、Eclipse上から設定する場合は、
メニューバーの[ファイル]-[新規]-[Springスターター・プロジェクト（Spring Initializr）]を選択することでブラウザと同様の設定ウィンドウが表示されるため、そちらから設定可能です。
補足
生成される雛形と構成について簡単に触れておきます。ポイントは4つ。
上記設定が完了したら、試しにSpringBootApplicationを起動し、設定に問題がないか確認しておきましょう。
起動方法はいくつかありますが、以下のいずれかの方法で起動してください。
起動後、コンソールに以下のような表示が出ていればOKです。
※一部文字化けして表示が崩れておりますがご了承ください。
問題ないことを確認できたら、プロセスの停止ボタンをクリックして停止しておきましょう。
. ____ _ __ _ _
/\ / ___'_ __ _ _(_)_ __ __ _
( ( )___ | '_ | '_| | '_ / _` |
\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |___, | / / / /
=========|_|==============|___/=/_/_/_/
[32m :: Spring Boot :: [39m [2m (v3.4.4)[0;39m
[2m2025-04-24T21:59:13.561+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mc.e.restapidemo.RestapidemoApplication [0;39m [2m:[0;39m Starting RestapidemoApplication using Java 17.0.6 with PID 22344 (C:pleiades2022-12workspacerestapidemorestapidemotargetclasses started by USER in C:pleiades2022-12workspacerestapidemorestapidemo)
[2m2025-04-24T21:59:13.564+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mc.e.restapidemo.RestapidemoApplication [0;39m [2m:[0;39m No active profile set, falling back to 1 default profile: "default"
[2m2025-04-24T21:59:14.876+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mo.s.b.w.embedded.tomcat.TomcatWebServer [0;39m [2m:[0;39m Tomcat initialized with port 8080 (http)
[2m2025-04-24T21:59:14.906+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mo.apache.catalina.core.StandardService [0;39m [2m:[0;39m Starting service [Tomcat]
[2m2025-04-24T21:59:14.906+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mo.apache.catalina.core.StandardEngine [0;39m [2m:[0;39m Starting Servlet engine: [Apache Tomcat/10.1.39]
[2m2025-04-24T21:59:15.041+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mo.a.c.c.C.[Tomcat].[localhost].[/] [0;39m [2m:[0;39m Initializing Spring embedded WebApplicationContext
[2m2025-04-24T21:59:15.041+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mw.s.c.ServletWebServerApplicationContext[0;39m [2m:[0;39m Root WebApplicationContext: initialization completed in 1405 ms
[2m2025-04-24T21:59:15.669+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mo.s.b.w.embedded.tomcat.TomcatWebServer [0;39m [2m:[0;39m Tomcat started on port 8080 (http) with context path "https://qiita.com/"
[2m2025-04-24T21:59:15.677+09:00[0;39m [32m INFO[0;39m [35m22344[0;39m [2m--- [ main] [0;39m[36mc.e.restapidemo.RestapidemoApplication [0;39m [2m:[0;39m Started RestapidemoApplication in 2.821 seconds (process running for 3.782)
実装に入る前に、REST APIについて簡単に触れておきます。
REST APIとはRESTの原則に従って設計されたAPIのことです。
RESTはWebサービスの設計に関する原則的な考え方を指す用語で、いくつかの原則が定められています。
その中の一つに「統一インターフェース」というものがあり、クライアント⇔サーバー間でやり取りするための方法があらかじめ定義されています。
具体的には、GETやPOSTといったHTTPメソッドを使って、リソースに対する操作を行います。
本記事では、GETを使った処理を実装して、実際の動きを確かめてみたいと思います。
ブラウザからHTTP GETリクエストを利用してSpring Bootに対してリクエストを送り、文字列を返すだけの簡単なAPIを実装してみましょう。
流れとしては、まず、Controllerを格納するパッケージを作成し、Controllerクラスを作成します。
Controllerクラス内にHTTP GETリクエスト用のメソッドを実装し、ブラウザで表示を確認するといった流れです。
Controllerクラスを格納するためのパッケージです。
手順
.controllerを入力com.example.restapidemo.controllerとなっていることを確認し、完了ボタンを押下クライアントからのリクエストを受け取り、リクエスト内容に応じて処理を実行するクラスです。
必要に応じて内部サービスやデータベースを呼び出し、ロジックの実行を依頼します。
手順
SampleControllerを入力して完了ボタンを押下以下のように、controllerパッケージの配下にSampleController.javaが作成されていればOKです。
restapidemo
∟srcmainjava
∟comexamplerestapidemo
∟controller
∟SampleController.java
∟RestapidemoApplication.java
では、作成したControllerクラスの中に処理を実装していきましょう。
通常、Controllerクラスには処理を実装せず、Serviceクラスに処理を依頼しますが、今回はブラウザにアクセスした際、文字列を返すだけですので、Controllerに処理を書いていきます。
手順
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SampleController {
※RestControllerをインポートしてください。保存でもインポートされるかと思います。
import org.springframework.web.bind.annotation.GetMapping;
～～～
@GetMapping(value="https://qiita.com/")
public String index() {
return "ようこそ、トップページへ！";
}
※GetMappingをインポートしてください。保存でもインポートされるかと思います。
@GetMapping(value="/qiita")
public String qiita() {
return "こんにちは、Qiita";
}
以上で処理の記載は完了です。全体としては以下のようになっているかと思います。
package com.example.restapidemo.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SampleController {
@GetMapping(value="https://qiita.com/")
public String index() {
return "ようこそ、トップページへ！";
}
@GetMapping(value="/qiita")
public String qiita() {
return "こんにちは、Qiita";
}
}
先程、SpringBootApplicationの起動をした時と同様に、起動してみましょう。
起動が完了したら、Boot ダッシュボード内のツールバーの「デフォルトURLでWebブラウザーを開く」（地球のようなマーク）をクリックしてください。
もしくは、ブラウザでhttp://localhost:8080/を開いていただいてもOKです。
アクセスすると、「ようこそ、トップページへ！」と表示されていることが確認できるかと思います。
これは、”https://qiita.com/”（トップページ）にGETリクエストがきた時に、index()メソッドが実行され、 “ようこそ、トップページへ！” を返却しているためです。
次に、URLの末尾に”/qiita”を追加してみてください。
すると、今度は”/qiita”にGETリクエストがきたため、qiita()メソッドが実行され、「こんにちは、Qiita」と表示されます。
Spring Bootはデフォルトで8080ポートで起動しますが、application.propertiesにポート番号を設定することで任意のポートに変更することが出来ます。
試しにポート番号を8081に変更してみましょう。
ポート番号の変更は、以下のようにserver.portに8081を指定してあげればOKです。
application.properties
spring.application.name=restapidemo
server.port=8081
SpringBootApplicationが起動中の場合は一度停止し、再度起動してみてください。
コンソールに以下のような表示が出ているかと思います。
Tomcat started on port 8081 (http) with context path "https://qiita.com/"
また、先程と同様に、ブラウザでhttp://localhost:8081にアクセスしてみると、
「ようこそ、トップページへ！」の表示が確認できます。
ここまでご覧いただきありがとうございます。
次の記事ではREST Clientを使用して、各HTTPメソッドを使用した動作について説明していますので、良ければそちらもご覧ください
Spring Bootを使ったREST APIの基本構築から動作確認まで②
Be the first to comment
