如何使用 Invoke-WebRequest 的 GET 方法构建查询字符串

Question

是否有一种标准方法可以在 PowerShell 中使用 Invoke-WebRequest 或 Invoke-RestMethod 使用查询字符串从网页获取信息？

例如，我知道以下内容与格式良好的 JSON 端点一起使用时会起作用：

$Parameters = @{
  Name = 'John'
  Children = 'Abe','Karen','Jo'
}
$Result = Invoke-WebRequest -Uri 'http://.....whatever' -Body ( $Parameters | ConvertTo-Json)  -ContentType application/json -Method Get

以及等效的 Invoke-WebMethod。其中一个重要方面是内容类型和 ConvertTo-JSON，它管理将 -Body 部分中指定的参数转换为标准形式，包括“Children”字段的数组方面。

对于使用逗号分隔的约定来管理 URL 中的数组参数或诸如“Children[]=Abe&Children[]=Karen&Children=Jo”之类的方法的网站，有什么等效方法可以做到这一点？

是否有我缺少的内容类型，是否有等效的 ConvertTo-？我可以使用吗？我的猜测是以前有人必须这样做。

对于上下文，这是一个经常使用的 在 URL 中编码数组参数的方式，常见于 PHP 网站。

passing arrays as url parameter

编辑 除特定上下文外，删除了对 PHP 的引用，并调整了标题以引用查询字符串。问题在于编码查询字符串而不是 PHP 本身。

Answer 1

似乎运行PHP的服务器在这里无关紧要。我想您是在问如何将键/值对作为查询字符串参数发送。

简单案例

如果是这样的话，你很幸运。 Invoke-RestMethod 和 Invoke-WebRequest 都将在正文中使用 [hashtable] 并为您构造查询字符串：

$Parameters = @{
    Name = 'John'
    Children = 'Abe','Karen','Jo'
}
Invoke-WebRequest -Uri 'http://www.example.com/somepage.php' -Body $Parameters -Method Get # <-- optional, Get is the default

传递复杂对象

现在看到问题是您希望查询字符串参数具有多个值，本质上是一个数组，这排除了您可以传递给 body 参数的数据类型。

因此，让我们先从[UriBuilder] 对象开始逐个构建URI，然后添加使用[HttpValueCollection] 对象构建的查询字符串（允许重复键）。

$Parameters = [System.Web.HttpUtility]::ParseQueryString([String]::Empty)
$Parameters['Name'] = 'John'
foreach($Child in @('Abe','Karen','Joe')) {
    $Parameters.Add('Children', $Child)
}

$Request = [System.UriBuilder]'http://www.example.com/somepage.php'

$Request.Query = $Parameters.ToString()

Invoke-WebRequest -Uri $Request.Uri -Method Get # <-- optional, Get is the default

Answer 2

以下似乎作为“第一次切割”工作得相当好。感谢@briantist 提供了使用.NET HttpValueCollection 的关键点。看来我们必须“滚动我们自己”的方式来构建查询字符串。

下面的代码片段显示了一种简单的方法，通过简单地遍历哈希表，将包含参数和值的哈希表转换为格式良好的查询字符串。一个限制是不允许嵌套（参数值不能是复杂类型，例如哈希表）。

# Setup, parameters is now a PowerShell hash table
# we convert that on the fly to an appropriate URL
$Parameters = @{
    Name = 'John'
    Children = 'Abe','Karen','Jo'
}
$Uri = 'http://example.com/somepage.php'
$AddSquareBracketsToArrayParameters = $true



$HttpValueCollection = [System.Web.HttpUtility]::ParseQueryString([String]::Empty)
foreach ($Item in $Parameters.GetEnumerator()) {
    if ($Item.Value.Count -gt 1) {
        # It is an array, so treat that as a special case.
        foreach ($Value in $Item.Value) {
            # Add each item in the array, optionally mark the name of the parameter
            # to indicate it is an array parameter.
            $ParameterName = $Item.Key
            if ($AddSquareBracketsToArrayParameters) { $ParameterName += '[]' }                 
            $HttpValueCollection.Add($ParameterName, $Value)
        }
    } else {
        # Add the scalar value.
        $HttpValueCollection.Add($Item.Key,$Item.Value)
    }
}
# Build the request and load it with the query string.
$Request  = [System.UriBuilder]($Uri)
$Request.Query = $HttpValueCollection.ToString()

# Now fire off the request.
Invoke-WebRequest -Uri $Request.Uri