REST APIで非常に深い関係を扱う

Question

私はREST APIを構築しています。私はリンクを非常に長くしている関係があります。彼らは私には意味をなさないが、それは混乱している。私はこれを処理する最善の方法が何であるか分かりません。長い間リンクしているのは問題ですか？私はこれらの原則に違反していますか？このような関係をどのように扱うべきですか？

以下の例は少し工夫されていますが、私が何をしようとしているかを示しています。

会社は、部が多く、である。各部には、の従業員が多数あります。各従業員は、多くの場合、台のコンピュータを持つことができます。各のコンピュータは、の文書を多数持つことができます。

GETへのパスは、特定の文書は次のようになります

/companies/:companyId/departments/:departmentId/employees/:employeeId/computers/:computerId/documents/:documentId 

を各IDは、その層内でグローバルに一意である - どの2つの文書IDは、システム全体にわたって同じしないであろうが、ドキュメントIDがあってもよいです従業員IDと同じです。

これは私にとっては理にかなっています。なぜなら、各レイヤーはその上の1つのものにしか関連付けられていないからです。部門は、単一の会社、単一の部署のみの従業員、単一の従業員のみのコンピュータ、および1台のコンピュータへの文書にのみ所属します。

/computersのような別個のエンドポイントにこれらを分割することができますが、どのようにそれらを壊すべきか分かりますか？なぜ/computersをエンドポイントとして選択し、/employees/:employeeId/computersを選択しないのですか？

Answer 1

この例では、これらのリソースのそれぞれをトップレベルに移動します。各トップレベルのリソースは、メンバーとして次の「レベル」を持つことができます。したがって、実際にエンドユーザーがコレクションの内容を操作する必要がある場合は、サブリソースのみを追加します。

深くネストされたリソースには問題があります。企業{id}のために働いている部門に関係なく、すべての従業員を見つけるためのビジネス要件が得られたら、3ヶ月後に何が起こりますか？従業員をトップレベルのリソースとして使用して、GET /employees?companyId={id}のサポートを追加します。上記のデザインでは、あなたの選択はすべて悪いです。あなたが持っているような入れ子構造を正式化するときに諦めるリソース間の関係には、多くの柔軟性があります。

は限り、あなたの特定の問題のいくつかのように：私はREST APIを構築しています

RESTは、URIの設計の主題に完全に依存しません。

私はリンクを非常に長くしている関係があります。彼らは私には意味をなさないが、それは混乱している。 [..]それほど長いリンクを持つのは問題ですか？

エンドユーザーは、うまくいけば、これらを入力することはありません。あなたのAPIが本当にRESTfulなであれば、クライアントはあなたが戻っているリンクを使用すると、彼らはどちらかでそれらを入力する必要はありません。 RESTfulなシステムでは、私はあなたのURIの形で文書化されているだけでなく、リンクに "私はいくつかのXの関係がある"ことを期待しています。私は彼らが長い側にいることに同意し、上記の理由でそれらを変更するだろうが、私はあなたの特定の懸念がそれらを変更する正当な理由だとは思わない。

私はこれらの原則に違反していますか？

私は認識していません。