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

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

新規登録して質問してみよう
ただいま回答率
85.50%
REST

REST(Representational State Transfer)はwebアプリケーションの構築スタイルの一種です。HTTP GET/POSTによってリクエストを送信し、レスポンスはXMLで返されます。SOAPのようなRPCの構築と比べるとサーバからクライアントを分離することが出来る為、人気です。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

Q&A

2回答

1287閲覧

Restful APIにおける子リソースのAPIのパス設計

kappazushi

総合スコア13

REST

REST(Representational State Transfer)はwebアプリケーションの構築スタイルの一種です。HTTP GET/POSTによってリクエストを送信し、レスポンスはXMLで返されます。SOAPのようなRPCの構築と比べるとサーバからクライアントを分離することが出来る為、人気です。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

0グッド

2クリップ

投稿2017/10/12 21:04

Restful APIで親リソースを指定した子リソースの指定方法はどのようにするべきでしょうか?

DBは以下の2つのような構造をもつモデルとなっています。
子のChildモデルは親のParentモデルのIDを知っています。

  • Parent model

parent.json

1{ 2 id: 42142141, 3}
  • Child model

child.json

1{ 2 id: 24214121, 3 parent_id: 42142141 4}

その時、子のモデルを親のIDから取得したいとします。
私の中ではどちらの指定方法がよろしいのでしょうか?

  1. パスに指定する方法
/api/v1/parents/42142141/children

2 クエリパラメターに指定する方法

/api/v1/children?parent_id=42142141

エンティティは親子関係を持っていますので、パスで指定するのも悪くないですし、
子のエンティティは親のIDを知っていますので、クエリパラメータでしていするのも悪くないと思います。

どちらが良いかご指導よろしくお願いします。

気になる質問をクリップする

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

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

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答2

0

クエリパラメータで指定するパターンの場合、一覧(GET)、詳細(GET)、新規作成入力(GET)、編集入力(GET)はいいのですが、追加(POST)、更新(PUT)、削除(DELETE)といったGET以外のメソッドのときにクエリパラメータが付くという気持ち悪いURLになるので、私は前者のパスに指定する方を取ります。

投稿2017/10/13 00:10

masaya_ohashi

総合スコア9206

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

こういった時にだいたいteratail APIを引き合いに出すのですが、teratail APIでは同様の状況、例えば特定のユーザーのフォロワーを取得するというAPIではエンドポイントは下記のように定義されます。display_nameがパラメータです。

https://teratail.com/api/v1/users/**__display_name__**/followers

ですので、「1.パスに指定する方法」の方を採用しているようです。
ご参考まで。

投稿2017/10/13 01:04

退会済みユーザー

退会済みユーザー

総合スコア0

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだベストアンサーが選ばれていません

会員登録して回答してみよう

アカウントをお持ちの方は

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

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問