この記事の目的
Springフレームワークを使用して、JavaでWeb APIを実装する方法をご紹介します。Springフレームワークを使用すると簡単にWeb APIを実装できます。
[広告]関連書籍
リンク
リンク
手順
Spring Initializrでプロジェクトのひな型を作成
下記URLにアクセスします。
https://start.spring.io/
下記のように入力して「GENERATE」ボタンを押します。すると「books-api.zip」がダウンロードできるので、好きな場所に解凍しておきます。
- Group : com.ottfoekst ※例なので好きな文字列を入力しても構いません。
- Artifact : books-api
- Dependencies : Spring Web、Lombokを指定
Spring Boot 3.3.2を使用するため、新しいJavaが必要です。本記事ではJava 21を使います。
プロジェクトのひな型をIntelliJにインポート
IntelliJを起動し、「New」>「既存ソースのプロジェクト」をクリックします。
「books-api.zip」フォルダを解凍したフォルダを指定して「OK」をクリックします。
「Gradle」を選択して「作成」をクリックします。
少し待つとGradleのビルドが完了し、プロジェクトのインポートが完了しました。
Web APIの実装
Google Book APIを呼び出して、検索条件に合致する書籍情報を取得するWeb APIを実装します。
Google Books APIs | Google for Developers
Google Books API を使用して、アプリでテキストの検索や書籍情報の取得を行えるようにする方法を学びます。
本記事ではテスト目的のためAPIキーを設定しませんが、本来はAPIキーの設定が必要です。APIキーを作成する手順は、下記外部記事をご覧ください。
Google Books API利用のためのAPIキー作成手順 - Qiita
はじめにGoogle Books API を利用する際の API キーを作成する手順についてまとめます。目次1. API キーの作成2. Books API の有効化3. API 制限の追加…
GoogleBooksAPIControllerクラスは、下記アノテーションを利用して実装されています。
- @RestController : RESTのWeb APIを実装するときに付与します。
- @GetMapping(“/books”) : 書籍情報の「取得」なのでGETを使います。URLは「/books」です。
- @RequestParam String query : クエリパラメータを指定します。「/books?query=XXX」の形式で指定できるようになります。
また、BookInfoクラスはタイトルとサムネイル画像URLをメンバ変数にもつクラスです。
起動と動作確認
BooksApiApplicationの緑矢印 > 「’BooksApiApplic…main()’の実行」をクリックします。
Webブラウザを開き、URLに「http://localhost:8080/books?query=Springフレームワーク」を入力してEnterキーを押すとちゃんとWeb APIを実装できていることが分かります。
コメント