对于Restful API,GET方法可以使用json数据吗?

时间:2015-04-10 21:56:37

标签: json api rest get

我不希望在URI中看到如此长的参数字符串。那么,GET方法可以使用json数据吗?

在我的情况下,我需要根据参数类型过滤结果。如果有很多参数,则长度可能超过URI的限制。那么,这个问题是否有最佳实践?

2 个答案:

答案 0 :(得分:26)

理论上,没有什么可以阻止您在GET请求中发送请求正文。 HTTP协议允许它,但没有定义的语义,因此您可以记录客户端发送GET有效负载时将要发生的确切情况。例如,您必须定义JSON主体中的参数是否等同于查询字符串参数或完全相同的其他内容。

但是,由于没有明确定义的语义,您无法保证应用程序和客户端之间的实现会尊重它。服务器或代理可能会拒绝整个请求,或忽略正文或其他任何内容。处理破坏的实现的REST方法是以与应用程序分离的方式规避它,所以我说你有两个选项可以被认为是最佳实践。

简单的选项是使用其他答案推荐的POST代替GET。由于POST未通过HTTP标准化,因此您必须记录该应该如何工作。这是最少的RESTful选项,但没关系。

我更喜欢的RESTful选项是在假设GET有效负载永不被篡改的情况下实现您的应用程序。然后,如果某些内容的实现中断,您允许客户端使用X-HTTP-Method-Override覆盖HTTP方法,这是客户端使用POST模拟HTTP方法的常用约定。因此,如果客户端具有损坏的实现,它可以将GET请求写为POST,发送X-HTTP-Method-Override: GET方法,并且您可以使用与应用程序实现分离的中间件,相应地重写方法。如果你是纯粹主义者,这是最好的选择。

答案 1 :(得分:6)

要回答您的问题,是的,您可以在URI中传递JSON作为GET请求的一部分(如果您使用URL编码)。但是,考虑到这样做的原因是由于URI的长度,使用JSON会弄巧成拙(引入的字符多于所需的字符数。)

我建议您以常规CGI样式(param1=val1&param2=val2)或JSON(在收到时由您的API解析)发送POST请求正文中的参数