json - 将 JSON 序列化为查询字符串的标准化方法？

Question

我正在尝试构建一个宁静的环境，并且正在努力将数据API序列化为.JSONHTTP query string

请求中需要传递许多强制和可选参数，例如（表示为下面的 JSON 对象）：

{
   "-columns" : [
      "name",
      "column"
   ],
   "-where" : {
      "-or" : {
         "customer_id" : 1,
         "services" : "schedule"
      }
   },
   "-limit" : 5,
   "return" : "table"
}

我需要支持各种数量的不同客户端，所以我正在寻找一种标准化的方法来将此 json 对象转换为查询字符串。有没有，它看起来怎么样？

另一种选择是允许用户只在消息正文中传递 json 对象，但我读到我应该避免它（HTTP GET with request body）。

有什么想法吗？

编辑澄清：

列出一些不同的语言如何编码上面给定的 json 对象：

• jQuery使用$.param：-columns[]=name&-columns[]=column&-where[-or][customer_id]=1&-where[-or][services]=schedule&-limit=5&return=column
• PHP使用http_build_query：-columns[0]=name&-columns[1]=column&-where[-or][customer_id]=1&-where[-or][services]=schedule&-limit=5&return=column
• Perl使用URI::query_form：-columns=name&-columns=column&-where=HASH(0x59d6eb8)&-limit=5&return=column
• Perl使用complex_to_query：-columns:0=name&-columns:1=column&-limit=5&-where.-or.customer_id=1&-where.-or.services=schedule&return=column

jQuery 和 PHP 非常相似。Perl 使用 complex_to_query 也与它们非常相似。但没有一个看起来完全一样。

Answer 1

URL 编码 ( https://en.wikipedia.org/wiki/Percent-encoding ) 您的 JSON 文本并将其放入单个查询字符串参数中。例如，如果你想通过{"val": 1}：

mysite.com/path?json=%7B%22val%22%3A%201%7D

请注意，如果您的 JSON 变得太长，那么您将遇到 URL 长度限制问题。在这种情况下，我会使用POST正文（是的，我知道，当您想要获取某些内容时发送 aPOST不是“纯粹的”并且不适合 REST 范式，但您的域特定的基于 JSON 的查询语言也不是） .

Answer 2

JSON查询字符串序列化没有单一的标准，所以我对比了一些JSON序列化器，结果如下：

JSON:    {"_id":"5973782bdb9a930533b05cb2","isActive":true,"balance":"$1,446.35","age":32,"name":"Logan Keller","email":"logankeller@artiq.com","phone":"+1 (952) 533-2258","friends":[{"id":0,"name":"Colon Salazar"},{"id":1,"name":"French Mcneil"},{"id":2,"name":"Carol Martin"}],"favoriteFruit":"banana"}
Rison:   (_id:'5973782bdb9a930533b05cb2',age:32,balance:'$1,446.35',email:'logankeller@artiq.com',favoriteFruit:banana,friends:!((id:0,name:'Colon Salazar'),(id:1,name:'French Mcneil'),(id:2,name:'Carol Martin')),isActive:!t,name:'Logan Keller',phone:'+1 (952) 533-2258')
O-Rison: _id:'5973782bdb9a930533b05cb2',age:32,balance:'$1,446.35',email:'logankeller@artiq.com',favoriteFruit:banana,friends:!((id:0,name:'Colon Salazar'),(id:1,name:'French Mcneil'),(id:2,name:'Carol Martin')),isActive:!t,name:'Logan Keller',phone:'+1 (952) 533-2258'
JSURL:   ~(_id~'5973782bdb9a930533b05cb2~isActive~true~balance~'!1*2c446.35~age~32~name~'Logan*20Keller~email~'logankeller*40artiq.com~phone~'*2b1*20*28952*29*20533-2258~friends~(~(id~0~name~'Colon*20Salazar)~(id~1~name~'French*20Mcneil)~(id~2~name~'Carol*20Martin))~favoriteFruit~'banana)
QS:      _id=5973782bdb9a930533b05cb2&isActive=true&balance=$1,446.35&age=32&name=Logan Keller&email=logankeller@artiq.com&phone=+1 (952) 533-2258&friends[0][id]=0&friends[0][name]=Colon Salazar&friends[1][id]=1&friends[1][name]=French Mcneil&friends[2][id]=2&friends[2][name]=Carol Martin&favoriteFruit=banana
URLON:   $_id=5973782bdb9a930533b05cb2&isActive:true&balance=$1,446.35&age:32&name=Logan%20Keller&email=logankeller@artiq.com&phone=+1%20(952)%20533-2258&friends@$id:0&name=Colon%20Salazar;&$id:1&name=French%20Mcneil;&$id:2&name=Carol%20Martin;;&favoriteFruit=banana
QS-JSON: isActive=true&balance=%241%2C446.35&age=32&name=Logan+Keller&email=logankeller%40artiq.com&phone=%2B1+(952)+533-2258&friends(0).id=0&friends(0).name=Colon+Salazar&friends(1).id=1&friends(1).name=French+Mcneil&friends(2).id=2&friends(2).name=Carol+Martin&favoriteFruit=banana

其中最短的是URL Object Notation。

Answer 3

另一个选项可能是node-querystring。它还使用与您迄今为止列出的方案类似的方案。

它在npm和中都可用bower，这就是我一直在使用它的原因。

Answer 4

你试试这个发送它们怎么样：

http://example.com/api/wtf?
[-columns][]=name&
[-columns][]=column&
[-where][-or][customer_id]=1&
[-where][-or][services]=schedule&
[-limit]=5&
[return]=table&

我尝试使用 REST 客户端

在服务器端（Ruby with Sinatra）我检查了参数，它给了我你想要的东西。:-)