如何构造一个REST API，它为资源提供一个id数组

How to construct a REST API that takes an array of id's for the resources

我正在为我的项目构建REST API。获取给定用户的INFO的API是：

1	api.com/users/[USER-ID]

我还想允许客户端传入用户ID列表。如何构建API以使其成为RESTful并获取用户ID列表？

相关讨论

如果要在URL上传递所有参数，那么逗号分隔值可能是最佳选择。然后你会有一个如下所示的URL模板：

1	api.com/users?id=id1,id2,id3,id4,id5

相关讨论

这种方法的问题在于它看起来并不安静。例如，如果我想获得此用户列表的朋友
@uclajatt，REST是一种架构模型而不是协议，如果你研究今天可用的主要REST API，你会发现有多种方法可以实现它。我建议的方法可能是最接近概念的方法之一，因为它完成了这里描述的所有约束：en.wikipedia.org/wiki/…。您只能使用CSV来表示请求中的数组，而服务响应应使用XML或JSON进行序列化。有什么特别的理由说明为什么你不认为我的方法是REST？
Florin的答案是OpenSocial API使用的实际方式。
在这种情况下，这种方法似乎很好。仅供参考：某些版本(交叉手指，好像要挡住吸血鬼)IE拒绝使用逗号分隔参数的网址。通常不是问题，但只是在测试时了解这一点...其他浏览器工作正常。
为什么不呢？ api.com/users?id=id1&id=id2&id=id3&id=id4&id=id5
@senfo，我更喜欢id = id1，id2，id3，因为它使URI更短且更容易阅读(例如，在调试操作期间，由人工)。如果ids之间存在其他参数，则每个值的各个参数将使URI更难以遵循：api.com/users?id=id1&id=id2&joined-after=2013-01-01&id=id3
@FlorinDumitrescu足够公平...... ;-)
@FlorinDumitrescu如何从数组中提取id(在javascript中声明)并将它们放在url中？
@SaharCh。"ID =" + arr.join("")
关于这种方法的一个注意事项是在各种框架中记录参数的方式。例如：JAX-RS：@Path('/ items / {id}')与@Path('/ items'} - 意思完全不同。
但是，大多数Web服务器支持大约2,000字节的URL长度。如何使我的API支持最多5,000个ID？
@senfo在…?id=1&id=2&id=3这样的URL中，无法保证将重复的查询参数组合到一个数组中。使用上面的查询字符串，PHP碰巧告诉你id等于[1, 2, 3]，但Ruby on Rails告诉你它等于3，而其他框架也可能有不同的行为，例如：说id等于1。像…?id=1,2,3这样的网址可以避免这种混淆的可能性。
@FlorinDumitrescu给出的URL不能是通用的，因为它取决于后端使用的数据库。因为对我来说使用mongoDB，这个url只生成给定的最后一个id。

1 2	api.com/users?id=id1,id2,id3,id4,id5 api.com/users?ids[]=id1&ids[]=id2&ids[]=id3&ids[]=id4&ids[]=id5

IMO，上面的调用看起来并不像RESTful，但这些是快速有效的解决方法(y)。但URL的长度受网络服务器的限制，例如tomcat。

RESTful尝试：

1
2
3
4
5
6
7
8
9
10
11
12
13
14

POST http://example.com/api/batchtask

[
{
method :"GET",
headers : [..],
url :"/users/id1"
},
{
method :"GET",
headers : [..],
url :"/users/id2"
}
]

服务器将回复新创建的批处理任务资源的URI。

1 2	201 Created Location:"http://example.com/api/batchtask/1254"

现在，客户端可以通过轮询获取批处理响应或任务进度

GET http://example.com/api/batchtask/1254

这是别人试图解决这个问题的方式：

Google云端硬盘
Facebook的
微软
Subbu Allamaraju

相关讨论

我找到了另一种使用@PathParam做同样事情的方法。这是代码示例。

1
2
3
4
5
6
7
8

@GET
@Path("data/xml/{Ids}")
@Produces("application/xml")
public Object getData(@PathParam("zrssIds") String Ids)
{
System.out.println("zrssIds =" + Ids);
//Here you need to use String tokenizer to make the array from the string.
}

使用以下网址调用该服务。

1	http://localhost:8080/MyServices/resources/cm/data/xml/12,13,56,76

哪里

1	http://localhost:8080/[War File Name]/[Servlet Mapping]/[Class Path]/data/xml/12,13,56,76

相关讨论

我更喜欢这种方法： -

1	api.com/users?id=id1,id2,id3,id4,id5

正确的方法是

1	api.com/users?ids[]=id1&ids[]=id2&ids[]=id3&ids[]=id4&ids[]=id5

要么

1	api.com/users?ids=id1&ids=id2&ids=id3&ids=id4&ids=id5

这就是机架的方式。 php就是这样做的。这也是节点如何做到的......

相关讨论

您可以使用ASP.NET MVC构建Rest API或Restful项目，并将数据作为JSON返回。
一个示例控制器功能是：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

public JsonpResult GetUsers(string userIds)
{
var values = JsonConvert.DeserializeObject<List<int>>(userIds);

var users = _userRepository.GetAllUsersByIds(userIds);

var collection = users.Select(user => new { id = user.Id, fullname = user.FirstName +""+ user.LastName });
var result = new { users = collection };

return this.Jsonp(result);
}
public IQueryable<User> GetAllUsersByIds(List<int> ids)
{
return _db.Users.Where(c=> ids.Contains(c.Id));
}

然后你只需通过提供Ids数组的常规AJAX函数调用GetUsers函数(在这种情况下，我使用jQuery stringify将数组作为字符串发送并在控制器中取消实现，但你可以发送整数数组并接收它作为控制器中的int数组)。我使用ASP.NET MVC构建了一个完整的Restful API，它将数据作为跨域json返回，并且可以在任何应用程序中使用。当然，如果你可以使用ASP.NET MVC。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

相关讨论