REST風サービスをJavaEEで構築する方法02(雛形プロジェクト編)

今回は最低限のREST風サービスを構築する方法を紹介する。

<前提条件>
下記の記事を読了していること。
・REST風サービスをJavaEEで構築する方法01(導入編)

<全体像から見た位置づけ>
Api層の実装を行う。

<手順概要>
1.プロジェクトの作成
2.クラスの作成
3.クラスを記述する
4.ApplicationConfigクラスを自動生成する

<手順詳細>
1.プロジェクトの作成
画面上部にある【新規プロジェクト】ボタンを押下する。

表示された「新規プロジェクト」ダイアログで[Java Web]>[Webアプリケーション]を選択し、【次>】ボタンを押下する。

プロジェクト名に「SampleRest」(※)を設定し、【次>】ボタンを押下する。
(※)任意の名前をつけることができる。

特に変更せず、【次>】ボタンを押下する。

何も選択せずに、【終了(F)】ボタンを押下する。

プロジェクトツリーに「SampleRest」という名前のプロジェクトが作成されたことを確認する。

2.クラスの作成
プロジェクトツリー上の「ソース・パッケージ」を右クリックし、[新規]>[Javaクラス]を選択する。

表示されたダイアログのクラス名に「SampleApi」(※)・パッケージ名に「lab.moonmt.SampleRest.api」(※)を設定し、【終了(F)】ボタンを押下する。
(※)任意の名前をつけることができる。

クラスが作成された事を確認する

3.クラスを記述する
手順2で作成したクラスを編集し、処理内容を記述する。

package lab.moonmt.SampleRest.api;

import javax.ws.rs.GET;
import javax.ws.rs.Path;

@Path("sampleApi")          //...(1)
public class SampleApi {
    
    @GET                    //...(2)
    @Path("getSample")      //...(3)
    public String getSampleMethod(){
                        
        return "Hello REST world";
    }  
}

ソースコード解説

番号	説明
(1)	@Pathアノテーションを使用し、クラスにアクセスするためのパスを設定する
(2)	@GETアノテーションを使用し、GETメソッドである事を設定する
(3)	@Pathアノテーションを使用し、メソッドにアクセスするためのパスを設定する

4.ApplicationConfigクラスを自動生成する
手順3で記述したクラス名の行番号付近を押下すると幾つかの選択肢が表示される。
その中の「Java EE 6仕様を使用してRESTを構成します」を押下すると、「ApplicationConfig」クラスが自動生成される。

<動作確認>
画面上部の実行ボタンを押下し、プロジェクトを実行する。

WebブラウザのURL欄に下記のURLを入力する
http://localhost:8080/SampleRest/webresources/sampleApi/getSample

URL解説

URL(部分)	説明
webresources	手順4で自動生成された「ApplicationConfig」クラス内の「@javax.ws.rs.ApplicationPath」に指定されている。任意の文字列に変更が可能である。
sampleApi	手順3で記述したクラスの「@Path」に指定している文字列
getSample	手順3で記述したメソッドの「@Path」に指定している文字列