WebAPIの設計とJerseyの実装について

Question

WebAPIの設計について
DBにINSERT（例えばメンバ追加）するAPIを
各種サイトを参考に
POST /member
としました。
その際に、名前を渡して、システムが割り当てるIDを返すようなIFとしようと思っていますが
これは一般的でしょうか？

Jerseyの実装について
上記を実現するとして以下のようなメソッドを考えています。

@POST
@Consumes("Application/JSON")
public Response insert(MemberBean inData) {
}

Responseにしているのは、結果をステータスコードで返すためですが、
このResponseに戻り値のJSONデータを載せるにはどうしたらよいでしょうか？
戻り値のデータもMemberBeanで返すことを考えています。

よろしくお願いいたします。

Answer 1

Responseを返すより、Beanを返す方が良い模様です。
ステータスは、WebApplicationExceptionのサブクラスをthrowすれば良い模様です。
参考↓
http://stackoverflow.com/questions/4687271/jax-rs-how-to-return-json-and-http-status-code-together

なお、Jersey2.xでないとダメなようです。

Answer 2

これは一般的でしょうか？

はい。RESTfulとして一般的だと思います。

DOA.insert()でDBにMemberBeanを挿入し、挿入した結果のIDがセットされたMemberBeanが返ってくるという想定で、以下のコードになりますかね。

	@POST
	@Produces({MediaType.APPLICATION_JSON})
	public MemberBean insert(MemberBean inserting) {
		MemberBean inserted = DOA.insert(inserting);
		return inserted;
	}

Comments

[darum]

このやり方の場合、例えばパラメータエラー時に、ステータス=400を返したい。
ということができない認識なのですが、いかがでしょうか？
ステータスコードを返すためにResponseを返す必要があるかと思っていました。

※ データをselectする、GETメソッドのIFでは、List<MemberBean> を返す設計です。

[chokojori]

Jerseyの場合、下記の様にWebApplicationExceptionクラスをスローするとHTTPステータスコードの400や500を呼び出し元へ戻します。

http://d.hatena.ne.jp/chronos_devel/20100827/1282855420

Answer 3

JSON を返すときはこんな書き方みたいですよ。

return Response.ok("{\"result\": \"ok\"}", MediaType.APPLICATION_JSON).build();

Comments

[darum]

@Produce(MediaType.APPLICATION_JSON)
と指定すると、メソッドの返り値Objectが、自動でJSONメッセージに変換される認識ですが、
そのような感じで手軽にJSONメッセージを生成することはできないでしょうか？