質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.49%

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

解決済

回答 3

投稿

  • 評価
  • クリップ 2
  • VIEW 3,431

score 72

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

Jerseyの実装について
上記を実現するとして以下のようなメソッドを考えています。
@POST
@Consumes("Application/JSON")
public Response insert(MemberBean inData) {
}
Responseにしているのは、結果をステータスコードで返すためですが、
このResponseに戻り値のJSONデータを載せるにはどうしたらよいでしょうか?
戻り値のデータもMemberBeanで返すことを考えています。


よろしくお願いいたします。
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 3

checkベストアンサー

0


これは一般的でしょうか?
はい。RESTfulとして一般的だと思います。

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/04/18 08:45

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

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

    キャンセル

  • 2015/04/18 15:33

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

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

    キャンセル

0

JSON を返すときはこんな書き方みたいですよ。
return Response.ok("{\"result\": \"ok\"}", MediaType.APPLICATION_JSON).build();

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/04/18 08:44

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

    キャンセル

0

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.49%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る