RestAssured の概要と作業環境の準備 

RestAssured は、REST API をテストおよび操作するための Java ライブラリです。 
GET、POST、PUT、DELETE などの HTTP リクエストをコードから送信し、UI ツールを使用せずにレスポンスを検証することができます。 

RestAssured は主に以下の目的で使用されます。 

  • API の HTTP ステータスコードを検証する 
     
  • レスポンス内のデータ(JSON / XML)を 確認・検証する 
     
  • API テストを 自動化する 
     
  • API テストを ビルドプロセスや CI/CD に統合する 
     

Java プロジェクトで RestAssured を使用するためには、以下のコンポーネントを準備する必要があります。 

  • Maven:ライブラリおよび依存関係(dependency)の管理 
     
  • JUnit:テストの実行および管理 
     
  • Jackson:レスポンス内の JSON データの処理 
     

そのため、最初に行うべき最も重要な作業は、標準的な Maven プロジェクトを作成し、必要な依存関係を正しく設定することです。 
環境構築が完了すれば、API テストの作成や拡張を 簡単かつ一貫した形で行うことができ、保守性も向上します。 

IntelliJ IDEA に統合された Maven の使用方法 

手順 1:新規プロジェクトの作成 

1.IntelliJ IDEA を起動し、 
File → New → Project を選択します。

2.New Project ウィンドウが表示されたら、左側のメニューから Maven を選択します。 

3.右側には、入力が必要な各項目が表示されます。 

手順 2:プロジェクト情報の入力 

Maven を選択した後、プロジェクト作成に必要な基本情報を入力します。 

  • Name 
    プロジェクト名を入力します。 
    例:RestAssuredDemo 
     
  • Location 
    プロジェクトを保存するフォルダを指定します。 
    例:D:\RestAssuredDemo\RestAssuredDemo 
     
  • JDK 
    インストール済みの Java バージョンを選択します(Java 11 以上を推奨)。 
    未設定の場合は、Add SDK → JDK をクリックして JDK のインストール先を指定します。 
  • Catalog 
    デフォルトの Internal のままで問題ありません。 
     
  • Archetype 
    maven-archetype-quickstart を選択します。 
    これは、src/main/java と src/test/java を含む基本的な Maven プロジェクト構成を自動生成する標準 archetype です。 

Version 
Archetype のバージョンは、デフォルト値(1.4 または 1.1)を使用して問題ありません。 
 手順 3:Create をクリックする 

すべての設定が完了したら、Create をクリックします。IntelliJ IDEA は、選択した設定内容に基づいて Maven プロジェクトを自動的に作成します。プロジェクト作成後、基本的な構成は次のようになります。

Maven プロジェクトでは、RestAssured や JUnit、Selenium などの 外部ライブラリは最初から含まれていません。 使用したいライブラリは、自分で宣言する必要があります。 
Maven は、その宣言内容に基づいてライブラリを自動的にダウンロードし、プロジェクトに追加します。Dependency(依存関係) とは、プロジェクトで使用する 外部ライブラリ のことを指します。 

代表的な例は以下の通りです。 

  • API テスト → RestAssured 
  • テスト実行・管理 → JUnit 
  • Excel ファイルの読み込み → Apache POI 

pom.xml に dependency を追加することは、Maven に対して 
「このライブラリを、このバージョンで使いたい」と伝えることと同じです。 

宣言後は、Maven が自動的にライブラリを検索・ダウンロード・管理するため、 
手動で jar ファイルを取得したり、個別に追加したりする必要はありません

手順 4:pom.xml に RestAssured の依存関係を追加する 

Maven プロジェクトでは、pom.xml ファイルが プロジェクトで使用するライブラリの一覧を管理します。 
RestAssured を使って API テストを実行するためには、必要なライブラリをこのファイルに追加する必要があります。 

この手順では、以下のライブラリを追加します。 

  • RestAssured:API リクエストの送信およびレスポンスの検証 
  • JUnit 5:@Test を使用したテストの実行 
  • Jackson Databind:レスポンス内の JSON データの処理 

手順 4.1:pom.xml ファイルを開く 

IntelliJ IDEA で、以下の手順を実行します。 

  • 左側の Project パネルを確認する 
  • プロジェクトの ルートフォルダ を開く 
  • pom.xml を ダブルクリックして開く 

手順 4.2:Maven プロジェクトに必要なライブラリを追加する 

pom.xml の <dependencies> … </dependencies> タグ内に、JUnit 5、RestAssured、Jackson Databind を追加します。これらの依存関係を設定することで、 
API テストの実行、レスポンスの検証、JSON データの処理が可能になります。

手順 4.3:Maven の依存関係を再読み込みする 

pom.xml を編集すると、IntelliJ IDEA にLoad Maven Changes ボタン、または Reload アイコンが表示されます。これをクリックして、変更内容を反映します。または、以下の操作でも実行できます。 

  • プロジェクトを右クリック 
  • Maven → Reload Project を選択 

Maven は自動的に JUnit 5、RestAssured、Jackson Databind の依存関係をダウンロードし、プロジェクトに追加します。

手順 5:Maven + RestAssured + Jackson Databind の設定を確認する 

IDE に統合された Maven、JUnit 5、および RestAssured + Jackson Databind が 
正しくセットアップされ、テストを実行できる状態であることを確認します。 

手順 5.1:Maven が依存関係を認識しているか確認する 

IntelliJ IDEA の右側にある Maven Projects タブを開きます。Maven Projects タブ内で、上部にある Reload All Maven Projects(🔄 アイコン)をクリックします。Maven は pom.xml に定義された すべての依存関係を読み込みます。 

手順 5.2:Project 内のライブラリを確認する 

左側のタブで Project View を開き、上部の表示モードを 「Project」 に設定します。 
一番下までスクロールし、External Libraries を展開します。以下のライブラリが表示されているかを確認してください: 

  • junit-jupiter 5.10.0 
  • rest-assured 5.4.0 
  • jackson-databind 2.15.2 

これらが表示されていれば、Maven は依存関係を正しく読み込んでいます。表示されていない場合は、Maven を再読み込みする、または インターネット接続を確認してください。 

手順 5.3:JUnit 5 と RestAssured の動作確認 

src/test/java 配下にテストクラスを作成します。 
例:DemoTest.java 

この手順では、JUnit 5 と RestAssured が正しくセットアップされているかを確認します。 
DemoTest クラスには、以下の 2 つのテストを実装します。 

  • JUnit 5 の動作確認用テスト 
    基本的な計算結果を検証し、JUnit 5 が正常に動作していることを確認します。 
  • RestAssured の動作確認用テスト 
    公開 API https://httpbin.org/get に対して GET リクエストを送信し、 
    HTTP リクエストが正常に実行できることを確認します。 

両方のテストが 成功(緑色表示) し、実行結果が exit code = 0 で終了すれば、プロジェクト環境は正しく構築されており、次のステップとして API テストを実装する準備が整った状態です。 

本記事では、RestAssured を用いた API テストを始めるために、 
Maven プロジェクトの作成、依存関係の設定、動作確認までの作業環境構築を行いました。Maven・JUnit 5・RestAssured・Jackson Databind を正しく設定することで、 
安定性が高く、保守・再利用しやすい API テスト基盤が整いました。 

この環境を土台として、次回は 「RestAssured の基本紹介」 として、 
Given–When–Then 構文や基本的な API テストの書き方を解説していきます。 

参考資料 

  • RestAssured を用いた API テスト入門 
    https://apidog.com/jp/blog/rest-assured-api-testing-jp/