资讯

历史

科技

环境与自然

成长

游戏

财经

文学与艺术

美食

健康

家居

文化

情感

汽车

三农

军事

旅行

运动

教育

生活

星座命理

PowerShell调用API的完整指南：从基础到实战

创作时间:

作者:

@小白创作中心

PowerShell调用API的完整指南：从基础到实战

引用

来源

https://docs.pingcode.com/baike/2697510

PowerShell 调用 API 的方法包括：使用 Invoke-RestMethod、Invoke-WebRequest、设置请求头、处理响应数据 。其中， 使用 Invoke-RestMethod 是最常用且简便的方法。下面将详细介绍如何使用 PowerShell 调用 API，并提供实际例子和代码示范。

一、使用 `Invoke-RestMethod`

Invoke-RestMethod 是 PowerShell 中最常用的命令之一，用于调用 RESTful API。它能够简化 API 调用的过程，并且能够自动处理 JSON 格式的数据。

基本用法

Invoke-RestMethod 的基本语法如下：

Invoke-RestMethod -Uri <URL> -Method <HTTP-Method> -Headers <Headers> -Body <Body>

示例一：GET 请求

$uri = "https://jsonplaceholder.typicode.com/posts/1"
$response = Invoke-RestMethod -Uri $uri -Method Get
$response

上述代码将向指定的 API 发送一个 GET 请求，并将响应存储在 $response 变量中。你可以通过 $response 访问 API 返回的数据。

示例二：POST 请求

$uri = "https://jsonplaceholder.typicode.com/posts"
$body = @{
    title = "foo"
    body = "bar"
    userId = 1
} | ConvertTo-Json
$response = Invoke-RestMethod -Uri $uri -Method Post -Body $body -ContentType "application/json"
$response

通过这种方式，你可以向 API 发送一个 POST 请求，并将 JSON 格式的数据作为请求体发送。

二、设置请求头

在实际应用中，API 通常需要认证信息，如 API 密钥或令牌。你可以通过设置请求头来发送这些信息。

示例：设置请求头

$uri = "https://api.example.com/data"
$headers = @{
    "Authorization" = "Bearer YOUR_API_TOKEN"
    "Content-Type" = "application/json"
}
$response = Invoke-RestMethod -Uri $uri -Method Get -Headers $headers
$response

在上述代码中，我们通过 $headers 变量设置了请求头，并在 Invoke-RestMethod 中使用 -Headers 参数传递这些头信息。

三、处理响应数据

API 响应的数据通常是 JSON 格式的，PowerShell 可以自动将其转换为对象，便于后续处理。

示例：处理 JSON 响应

$uri = "https://jsonplaceholder.typicode.com/posts/1"
$response = Invoke-RestMethod -Uri $uri -Method Get
访问响应数据
$title = $response.title
$body = $response.body
Write-Output "Title: $title"
Write-Output "Body: $body"

在上述代码中，API 返回的数据被自动转换为 PowerShell 对象，你可以直接通过对象的属性访问数据。

四、错误处理

在调用 API 时，处理错误响应是非常重要的。你可以使用 try-catch 块来捕获和处理错误。

示例：错误处理

$uri = "https://jsonplaceholder.typicode.com/posts/invalid"
try {
    $response = Invoke-RestMethod -Uri $uri -Method Get
    Write-Output $response
} catch {
    Write-Error "Failed to call API: $_"
}

在上述代码中，如果 API 调用失败，将捕获异常并输出错误信息。

五、实际应用

示例一：调用 GitHub API

$uri = "https://api.github.com/repos/PowerShell/PowerShell"
$headers = @{
    "User-Agent" = "PowerShell"
}
$response = Invoke-RestMethod -Uri $uri -Method Get -Headers $headers
Write-Output "Repository Name: $($response.name)"
Write-Output "Stars: $($response.stargazers_count)"
Write-Output "Forks: $($response.forks_count)"

示例二：调用天气 API

$apiKey = "YOUR_API_KEY"
$city = "London"
$uri = "http://api.openweathermap.org/data/2.5/weather?q=$city&appid=$apiKey"
$response = Invoke-RestMethod -Uri $uri -Method Get
Write-Output "City: $($response.name)"
Write-Output "Temperature: $($response.main.temp) K"
Write-Output "Weather: $($response.weather[0].description)"

在上述示例中，我们调用了 GitHub API 和天气 API，通过设置请求头和处理响应数据，成功获取了所需的信息。