私は個人的なプロジェクトのために最初のRESTAPIを構築しています(少なくとも試してみました)。
このプロジェクトには、player
sと呼ばれるリソースがありteam
ます。REST API設計ルールブックによると、リソースはドキュメント またはストアのいずれかになり、これらの役割を可能な限り分離しておく必要があります。
team
それでも、リソースにいくつかのメタデータを追加したいと思います。たとえば、team
が設立された日付です。それでは、このメタデータをチーム内のsのリスト(ストアにする)と一緒GET /teams/atlanta
に返す(ドキュメントにする)ことはできますか?player
これは良い考えですか?もしそうなら、なぜですか?そうでない場合は、なぜそうではなく、これをよりよく解決する方法は?
REST APIを開発するためのルールがないことは知っていますが、優れたプラクティスがあり、それらを順守したいと思います。また、これが本当に私の最初のREST APIであるということではないので、もしあれば私の無知を許してください。