json - 用于检索摘要信息的 REST api 设计

Question

我有一个场景，在这个场景中，我有 REST API 来管理一个我们称之为 Group 的资源。
群组在概念上类似于 Google 网上论坛中的论坛。

现在我有两个 GET 访问方法，我认为它们需要单独的表示。

第一种 GET 访问方法检索有关组的最少量信息。
给定一个 group_id，它应该返回最少量的信息，例如

{ 
    group_id: "5t7yu8i9io0op",
    group_name: "Android Developers",
    is_moderated: true,
    number_of_users: 34,
    new_messages: 5,
    icon: "http://boo.com/pic.png"
}

第二个 GET 访问方法检索本质上更具统计性的摘要信息，例如:

{ 
    group_id: "5t7yu8i9io0op",
    top_ranking_users: {
      [ { user: "george", posts: 789, rank: 1 }, 
        { user: "joel", posts: 560, rank: 2 }  ...]
    },
    popular_topics: {
      [ ... ]
    }
}

我想分离这些数据访问方法，我目前正在计划这样的设计:

GET /group/:group_id/
GET /group/:group_id/stat

只有后者才会返回组的统计信息。你怎么看待这件事 ？

Answer 1

我不认为你的方法有问题。由于统计数据基本上是单独的数据，因此您也可以将统计数据视为单独的资源，提供一个 URI，如

GET /stat/:group_id

此外，您可以交叉引用您的资源(意味着组链接到相应的统计资源，反之亦然):

GET /group/5t7yu8i9io0op

{ 
    group_id: "5t7yu8i9io0op",
    group_name: "Android Developers",
    is_moderated: true,
    number_of_users: 34,
    new_messages: 5,
    icon: "http://boo.com/pic.png",
    stats: "http://mydomain.com/stat/5t7yu8i9io0op"
}

GET /stat/5t7yu8i9io0op

{ 
    group: "http://mydomain.com/group/5t7yu8i9io0op",
    top_ranking_users: {
      [ { user: "george", posts: 789, rank: 1 }, 
        { user: "joel", posts: 560, rank: 2 }  ...]
    },
    popular_topics: {
      [ ... ]
    }
}