rest - 在 RESTful API 设计中获取用户配置文件的最佳实践是什么

Question

就我而言，每个用户都有一个包含许多属性的配置文件，例如性别、年龄、姓名。设计 RESTful API 以获取这些属性的最佳实践是什么？以下是可能的解决方案:

在一次调用中获取所有属性

获取所有属性:
请求:GET http://api.domain.com/users/id/profile
回复:{"name" : "Jim", "gender" : "male", "age" : 12}

一一获取属性

获取属性列表:

请求:GET http://api.domain.com/users/id/profile
回复:{ "attributes" : ["name", "gender", "age"] }
获取指定的属性:

请求:GET http://api.domain.com/users/id/profile/name
回复:{"name" : "Jim"}

使用第一个解决方案，客户端在一次调用中获取所有属性。然而，问题在于 属性太多，我们会在配置文件中添加更多属性 .我想知道哪个更好？

Answer 1

如果您有很多很多属性，另一种方法是将它们分组。
在 REST 中，一切都必须是资源(例如但不限于可通过 URL 识别的东西)。
所以你可以有

GET http://api.domain.com/users/id/profile

你得到

{ "categories" : ["names", "address", "interests", "jobhistory", "publications", "blogs", "skills"] }

然后你进一步查询。这确实意味着多次旅行，但您不必一一查询许多属性，例如，最终会得到 75 个属性中的 50 个查询，但可能需要 3 个查询才能获得所需的 50 个属性。