Jerseyの@PathParamはスラッシュの間に複数指定できる

公開日: : プログラム ,

http://hoge-api/user/{id}.{format} のような URL も以下のように @PathParam を2つ指定すれば、それぞれのパラメータを取得できるというメモ。

@GET
@Path("/user/{id}.{format}")
@Produces(MediaType.APPLICATION_JSON)
public Response getData(@PathParam("id") String id, @PathParam("format") String format) {
    //
}

こういう指定ができないものと勝手に勘違いしていたのだが同じ間違いをしないように、という教訓のメモ。

icatch-jersey_multi_pathparams

目次

1. どのように勘違いしていたのか

URL のスラッシュ(”/”)の間に @PathParam は1つしか書けないと思っていた。例えば以下のような URL 。

  • http://hoge-api/user/{id}.{format} ← こういう書き方はできないと思っていた

なので、次のような URL でしか表現できないと勘違いしていた。

  • http://hoge-api/user/{id_and_format}
  • http://hoge-api/user/{id}/{format}

2. 検証

ここまででこの記事に書きたいことは全部書いたが、もうちょっとヒントになりそうなことも書いておく。

2-1. 仕様例

http://hoge-api/user/{id}.{format} に GET でアクセスするとユーザ情報が取得できる、という API だったとする。

  • “{id}” にユーザ IDを指定する
  • “{format}” に “json” とか “xml” などレスポンスボディの形式を指定する

2-2. ソフトウェアのバージョン

検証に使った主なソフトウェアのバージョンは以下の通り。

  • Java: Java8
  • Jersey: 2.13
  • Jetty: 9.3.0.v20150612

この検証に直接関係ないものも含まれているが、Jersey 関連の dependency は以下の通り。

<dependency>
  <groupId>org.glassfish.jersey.containers</groupId>
  <artifactId>jersey-container-servlet</artifactId>
  <version>${jersey2.version}</version>
</dependency>
<dependency>
  <groupId>org.glassfish.jersey.media</groupId>
  <artifactId>jersey-media-moxy</artifactId>
  <version>${jersey2.version}</version>
</dependency>
<dependency>
  <groupId>org.glassfish.jersey.media</groupId>
  <artifactId>jersey-media-json-jackson</artifactId>
  <version>${jersey2.version}</version>
</dependency>
<dependency>
  <groupId>org.glassfish.jersey.ext</groupId>
  <artifactId>jersey-bean-validation</artifactId>
  <version>${jersey2.version}</version>
</dependency>

また、アプリケーションを Jetty で動かすための plugin 設定は次の通り。

<plugin>
  <groupId>org.eclipse.jetty</groupId>
  <artifactId>jetty-maven-plugin</artifactId>
  <version>9.3.0.v20150612</version>
  <configuration>
    <scanIntervalSeconds>2</scanIntervalSeconds>
    <webApp>
      <contextPath>/hoge-api</contextPath>
    </webApp>
  </configuration>
</plugin>

2-3. プログラム

すでに冒頭でも書いたが、http://hoge-api/user/{id}.{format} に対応するリソースクラスのメソッド例は以下の通り。

@GET
@Path("/user/{id}.{format}")
@Produces(MediaType.APPLICATION_JSON)
public Response getData(@PathParam("id") String id, @PathParam("format") String format) {
    //
}

3. 更新履歴

  • 2015/10/22: 初版作成

Googleアドセンス用(PC)

  • このエントリーをはてなブックマークに追加
  • follow us in feedly

関連記事

icatch-vacuum_9060011568_mini-thumbnail

GitHub にアップされているブランチをローカルに取り込む

GitHub に限らず、会社や自分で Git のサーバを使った場合にも当てはまりますが、毎回同じこと

記事を読む

icatch_5428744075-resized

scp を使ってファイルのコピーを実行したら “command not found” と表示されたときの対処法

CentOS が起動しているサーバに scp を使ってファイルをコピーしようとコマンドを実行したら

記事を読む

icatch-thumbup_3507728739_mini-thumbnail

Sublime Text3 に SublimeLinter-jshint をインストールしてみた

エディタに Eclipse を使って Java のプログラムを書くことが多いんですが、JavaScr

記事を読む

icatch-2015-005-1

ユニットテストの偏りを防ぐ命名規則の付け方

ユニットテスト名に以下の命名規則を付けるようにして二ヶ月ぐらい経った。 正常系テストの場合: 正

記事を読む

icatch-2015-006-1

バリデーションチェックにJava8のOptionalを使ってスマートに書く(自分比)

Web アプリのバリデーションチェックにアノテーションを使うことが増えた。だが、アノテーションで実装

記事を読む

icatch-8785445626_587fdac14d_z-resized

検証用の CentOS をインストールした直後に行う初期設定手順

職場でも自宅でも Linux で検証したい作業があったので VMware に 64 ビット版の Ce

記事を読む

icatch-_9692711856-resized

シェルスクリプトでメールを送信する

このブログを運用している Linux サーバの監視スクリプトを作成した記事を書きました。 ロード

記事を読む

icatch_2385618390-resized

Linuxでmp3をお手軽に結合する

このブログを運用している Linux サーバで radiko.jp から番組を mp3 に録音して個

記事を読む

icatch-2015-003-1

Vagrantで起動したCentOS上のMySQLにホストOSからログインする設定

マシンを新しくしたこともあり、検証と称してソフトウェアをやみくもにインストールすることに抵抗が出てき

記事を読む

icatch-markdown_6281167385_mini-thumbnail

Sublime Text3 で Markdown のシンタックスハイライトを有効にする手順

IT 関連の職場であれば、部署やチーム単位に Redmine とか Backlog を使って TOD

記事を読む

Googleアドセンス用(PC)

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です


+ 4 = 九

次のHTML タグと属性が使えます: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Googleアドセンス用(PC)

icatch-jersey_multi_pathparams
Jerseyの@PathParamはスラッシュの間に複数指定できる

http://hoge-api/user/{id}.{format}

icatch-vagrant_box_customize
VagrantのBoxファイルをカスタマイズして独自のBoxファイルを作成する

配布されている Vagrant の Box ファイルを使って検証環境を

icatch-2015-006-1
バリデーションチェックにJava8のOptionalを使ってスマートに書く(自分比)

Web アプリのバリデーションチェックにアノテーションを使うことが増え

icatch-2015-005-1
ユニットテストの偏りを防ぐ命名規則の付け方

ユニットテスト名に以下の命名規則を付けるようにして二ヶ月ぐらい経った。

icatch-2015-004-1
Vagrantで起動したCentOS上のOctopressをホストOSから確認する設定

タイトルの通りだが、Vagrant を使って起動した CentOS に

→もっと見る

PAGE TOP ↑