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

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

ただいまの
回答率

90.76%

  • API

    1435questions

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

  • REST

    128questions

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

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

受付中

回答 2

投稿

  • 評価
  • クリップ 2
  • VIEW 308

kappazushi

score 7

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

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

  • Parent model
{
  id: 42142141,
}
  • Child model
{
  id: 24214121,
  parent_id: 42142141
}

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

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

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

/api/v1/children?parent_id=42142141

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

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

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

回答 2

+1

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

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

0

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

https://teratail.com/api/v1/users/display_name/followers

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

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

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

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

関連した質問

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

  • API

    1435questions

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

  • REST

    128questions

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