チュートリアル: 初めての RESTful Web サービス

JAX-RS を使用して新しい Jakarta EE プロジェクトを作成する

IntelliJ IDEA には、さまざまな Jakarta EE 実装に基づいて Jakarta EE プロジェクトを作成するための専用ウィザードが含まれています。 このチュートリアルでは、簡単な Web アプリケーションを作成します。

1. 新規プロジェクト ウィザードを開く：

   • ホーム画面を表示している場合は、 新規 | プロジェクト… を選択します。

   • 別のプロジェクトを開いている場合は、 ファイル | 新規 | プロジェクト に移動します。

2. 左側の ジェネレーター リストから、 Jakarta EE を選択します。

   

3. プロジェクト設定を次のように設定します:

   • 名前: JakartaRESTHelloWorld

   • ロケーション: そのままにする

   • Git リポジトリの作成: そのままにする

   • テンプレート: REST サービス

   • アプリケーションサーバー: <アプリケーションサーバーなし>

   • 言語: Java

   • ビルドシステム: Maven

   • グループ: そのままにする

   • アーティファクト: そのままにする

   • JDK: Eclipse Temurin 21

   準備ができたら、 次へ をクリックします。

4. バージョン ドロップダウンリストから、このチュートリアルで使用する Tomcat 11 と互換性がある Jakarta EE 11 を選択します。 Jakarta EE 9.1 は、このチュートリアルで使用する GlassFish 6.2.5 と互換性があるためです。

   前のステップで REST サービステンプレートを選択したため、 依存関係 リストでは一部の仕様がすでに選択されています。 このチュートリアルでは、他の依存関係を選択する必要はありません。

   

5. 前のステップで REST サービステンプレートを選択したため、 依存関係 リストでは一部の仕様がすでに選択されています。 ただし、それらの実装も選択する必要があります: Eclipse Jersey サーバー と Weld SE。

   

6. 作成 をクリックします。

デフォルトのプロジェクト構造を調べる

IntelliJ IDEA は、正常にビルドおよびデプロイできる定型コードを使用してプロジェクトを作成します。

• pom.xml は、プロジェクトのビルドに必要な依存関係やプラグインなど、Maven 構成情報を備えた プロジェクトオブジェクトモデルです。

  <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.example</groupId> <artifactId>RestTomcatHelloWorld</artifactId> <version>1.0-SNAPSHOT</version> <name>RestTomcatHelloWorld</name> <packaging>war</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.target>21</maven.compiler.target> <maven.compiler.source>21</maven.compiler.source> <junit.version>5.11.0-M2</junit.version> </properties> <dependencies> <dependency> <groupId>jakarta.servlet</groupId> <artifactId>jakarta.servlet-api</artifactId> <version>6.1.0</version> <scope>provided</scope> </dependency><dependency> <groupId>org.glassfish.jersey.containers</groupId> <artifactId>jersey-container-servlet</artifactId> <version>4.0.0-M1</version> </dependency> <dependency> <groupId>org.glassfish.jersey.media</groupId> <artifactId>jersey-media-json-jackson</artifactId> <version>4.0.0-M1</version> </dependency> <dependency> <groupId>org.glassfish.jersey.inject</groupId> <artifactId>jersey-cdi2-se</artifactId> <version>4.0.0-M1</version> </dependency><dependency> <groupId>org.jboss.weld.se</groupId> <artifactId>weld-se-core</artifactId> <version>6.0.0.Beta1</version> </dependency> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter-api</artifactId> <version>${junit.version}</version> <scope>test</scope> </dependency> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter-engine</artifactId> <version>${junit.version}</version> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>3.4.0</version> </plugin> </plugins> </build> </project>
  <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.example</groupId> <artifactId>RestTomcatHelloWorld</artifactId> <version>1.0-SNAPSHOT</version> <name>RestTomcatHelloWorld</name> <packaging>war</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.target>11</maven.compiler.target> <maven.compiler.source>11</maven.compiler.source> <junit.version>5.9.2</junit.version> </properties> <dependencies> <dependency> <groupId>jakarta.servlet</groupId> <artifactId>jakarta.servlet-api</artifactId> <version>5.0.0</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.glassfish.jersey.containers</groupId> <artifactId>jersey-container-servlet</artifactId> <version>3.0.4</version> </dependency> <dependency> <groupId>org.glassfish.jersey.media</groupId> <artifactId>jersey-media-json-jackson</artifactId> <version>3.0.4</version> </dependency> <dependency> <groupId>org.glassfish.jersey.inject</groupId> <artifactId>jersey-cdi2-se</artifactId> <version>3.0.4</version> </dependency> <dependency> <groupId>org.jboss.weld.se</groupId> <artifactId>weld-se-core</artifactId> <version>4.0.3.Final</version> </dependency> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter-api</artifactId> <version>${junit.version}</version> <scope>test</scope> </dependency> <dependency> <groupId>org.junit.jupiter</groupId> <artifactId>junit-jupiter-engine</artifactId> <version>${junit.version}</version> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>3.3.2</version> </plugin> </plugins> </build> </project>

• HelloResource.java は ルートリソースクラスであり、次の JAX-RS アノテーションを使用して RESTfulWeb サービスを実装します。

  • @Path アノテーションは、アプリケーションルートを基準にして、このリソースにアクセスするための URI を識別します。

  • @GET アノテーションは、 hello() メソッドが指定された URI への HTTP GET 要求を処理することを示します。

  • @Produces アノテーションは、メソッドが生成して返す MIME メディアタイプを指定します。

  package com.example.restglassfishhelloworld; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import jakarta.ws.rs.Produces; @Path("/hello-world") public class HelloResource { @GET @Produces("text/plain") public String hello() { return "Hello, World!"; } }
  package com.example.resttomcathelloworld; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import jakarta.ws.rs.Produces; @Path("/hello-world") public class HelloResource { @GET @Produces("text/plain") public String hello() { return "Hello, World!"; } }

• HelloApplication.java は javax.ws.rs.core.Application のサブクラスであり、アプリケーションがリソースクラスで定義された REST リソースを実行する環境を構成するために使用されます。 @ApplicationPath アノテーションは、アプリケーションルートの URL マッピングを識別します（デフォルトでは、 /api に設定されています）。

  package com.example.restglassfishhelloworld; import jakarta.ws.rs.ApplicationPath; import jakarta.ws.rs.core.Application; @ApplicationPath("/api") public class HelloApplication extends Application { }
  package com.example.resttomcathelloworld; import jakarta.ws.rs.ApplicationPath; import jakarta.ws.rs.core.Application; @ApplicationPath("/api") public class HelloApplication extends Application { }

アプリケーションサーバーを構成する

IntelliJ IDEA に、 GlassFish Tomcat アプリケーションサーバーが配置されている場所を知らせます。

1. Ctrl+Alt+S を押して設定を開き、 ビルド、実行、デプロイ | アプリケーションサーバー を選択します。

2. をクリックし、 GlassFish サーバーTomcat を選択します。

3. GlassFish Tomcat サーバーのインストール場所へのパスを指定します。 IntelliJ IDEA は、名前とバージョンを適切に検出して設定します。

   

   

実行構成の作成

IntelliJ IDEA は、アーティファクトを構築してアプリケーションサーバーにデプロイするための実行構成を必要とします。

1. メインメニューで、 実行 | 実行構成の編集 に移動します。

2. 実行 / デバッグ構成 ダイアログで、 をクリックし、 GlassFish サーバーTomcat サーバー ノードを展開して、 ローカル を選択します。

3. 実行構成設定ダイアログの下部に表示される警告を修正します。

   

   ほとんどの場合、以下を修正する必要があります。

   • サーバー タブで、 サーバードメイン を domain1 に設定します。

   • デプロイ タブで、デプロイするアーティファクトを追加します: RestGlassfishHelloWorld:war explodedRestTomcatHelloWorld:war exploded

4. サーバー タブで、ルートリソースを指すように URL を設定します。

   http://localhost:8080/RestGlassfishHelloWorld-1.0-SNAPSHOT/api/hello-world
   http://localhost:8080/RestTomcatHelloWorld_war_exploded/api/hello-world

   

   

5. OK をクリックして、実行構成を保存します。

6. 構成を実行するには、 Alt+Shift+F10 を押して、作成したアプリケーションサーバー構成を選択します。

   あるいは、上部のメインツールバーで実行構成を選択している場合は、メインツールバーの をクリックするか、 Shift+F10 を押して実行できます。

この実行構成は、アーティファクトを作成してから、 GlassFish Tomcat サーバーを起動し、アーティファクトをサーバーにデプロイします。 サービス ツールウィンドウに対応する出力が表示されます。

これが完了すると、IntelliJ IDEA は指定された URL を Web ブラウザーで開きます。

そうでない場合は、自分で URL を開いてみてください: http://localhost:8080/RestGlassfishHelloWorld-1.0-SNAPSHOT/api/hello-world http://localhost:8080/RestTomcatHelloWorld_war_exploded/api/hello-world