5

質問は、JSON API の仕様と、リクエストを適切に行う方法についてです (私は ruby​​ on rails と json api resources gem を使用していますが、とにかく一般的な質問です。実装方法は知っています。JSON のルールに従いたいだけです)。 API: http://jsonapi.org/format/ )

状況 1:

  • すべての棚を取得したい
  • それらの棚にあるすべての本を含めたい
  • この場合に使用することになっている get は次のとおりです。 www.library.com/shelves?include=books

状況 2:

  • すべての本を取得したいが、未読としてマークされている本だけを取得したい

  • 私が使用することになっている取得は次のとおりです。 www.library.com/books?filter[unread]=true

未読の本を含むすべての棚のリクエストを設計する正しい方法はどれですか?

これを理解することはできません

www.library.com/shelves?include=books&filter[books.unread]=true?

www.library.com/shelves?include=unread_books? <- 別のリソース、未読の書籍を指定する必要があります

www.library.com/shelves?filter[books.unread]=true?

これを行う最も正しい方法は何ですか?

編集

私のテクニカル リードや他の数人のプログラマーと話し合った結果、このような場合は最初のオプションが最も好まれます。

4

2 に答える 2

7

私は最初のものに賭けます：

www.library.com/shelves?include=books&filter[books.unread]=true
于 2016-10-23T16:40:38.653 に答える
2

JSON API は現在、インクルードのフィルタリングをサポートしていませんが、これは定義を厳密にする必要があるという意味ではありません ( https://github.com/cerebris/jsonapi-resources/issues/314を確認してください) 。

私はブライアンと同じアプローチをとります： www.library.com/shelves?include=books&filter[books.unread]=true

答えの背景をもう少し説明したかっただけです。

于 2016-11-23T12:22:27.433 に答える