当前位置：首页 > 行业动态 > 正文

c# 怎么调用api

admin
行业动态
2025-03-19
1

在C#中调用API通常使用 HttpClient类。以下是一个简单的示例，展示如何发送GET请求并处理响应：“

csharp，using System;，using System.Net.Http;，using System.Threading.Tasks;class Program，{， static async Task Main(string[] args)， {， using (HttpClient client = new HttpClient())， {， client.BaseAddress = new Uri("https://api.example.com/");， HttpResponseMessage response = await client.GetAsync("endpoint");， response.EnsureSuccessStatusCode();， string responseBody = await response.Content.ReadAsStringAsync();， Console.WriteLine(responseBody);， }， }，}，

` 这个示例代码展示了如何使用HttpClient`发送一个GET请求到指定的API端点，并输出响应内容。

C# 中调用 API 的详细步骤

在 C# 中调用 API 通常涉及以下几个关键步骤：

一、准备工作

1、确定 API 端点和认证方式

首先要明确你要调用的 API 的 URL 地址，也就是 API 端点，一个获取天气信息的 API 端点可能是“https://api.weather.com/getWeather”。

了解该 API 所需的认证方式，常见的有 API Key 认证，有些 API 可能还需要 OAuth 认证等方式，这取决于 API 提供者的要求，如果是 API Key 认证，你需要从 API 提供者那里获取一个唯一的 API Key，后续在请求中会用到它来验证你的身份和授权。

2、添加必要的 NuGet 包（可选）

根据 API 的类型和你要进行的操作，可能需要添加一些 NuGet 包来简化开发过程，如果要处理 HTTP 请求，可能会用到“HttpClient”相关的包；API 返回的数据是 JSON 格式，通常会用到“Newtonsoft.Json”包来进行 JSON 的序列化和反序列化，你可以通过 Visual Studio 的 NuGet 管理器或者在命令行中使用“dotnet add package”命令来添加这些包。

二、创建 HTTP 客户端并发送请求

1、创建 HttpClient 实例

c# 怎么调用api

在 C# 中，可以使用“HttpClient”类来发送 HTTP 请求，首先需要创建一个“HttpClient”对象，

 using System.Net.Http;
   HttpClient client = new HttpClient();

你还可以配置“HttpClient”的一些属性，如设置超时时间等。

 client.Timeout = TimeSpan.FromSeconds(10);

2、构建请求消息

根据 API 的要求构建请求消息，如果是 GET 请求，通常只需要指定 API 端点和查询参数（如果有），要向上述天气 API 发送 GET 请求获取某个城市（如北京）的天气信息，API 需要一个名为“city”的查询参数和一个 API Key 作为请求头：

 string apiUrl = "https://api.weather.com/getWeather";
   string city = "Beijing";
   string apiKey = "your_api_key_here";
   string requestUri = $"{apiUrl}?city={city}";
   HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, requestUri);
   request.Headers.Add("Authorization", $"Bearer {apiKey}");

如果是 POST 请求，除了指定 URL 外，还需要设置请求内容，假设有一个用户注册的 API，需要发送用户的用户名、密码等信息：

 string registerUrl = "https://api.example.com/register";
   string jsonContent = "{"username":"newuser","password":"password123"}";
   HttpRequestMessage postRequest = new HttpRequestMessage(HttpMethod.Post, registerUrl);
   postRequest.Content = new StringContent(jsonContent, Encoding.UTF8, "application/json");

3、发送请求并接收响应

使用“HttpClient”的“SendAsync”方法发送请求并等待响应，对于上面的天气信息 GET 请求：

c# 怎么调用api

 Task<HttpResponseMessage> responseTask = client.SendAsync(request);
   HttpResponseMessage response = await responseTask;

检查响应的状态码，如果状态码是 2xx（如 200 OK），则表示请求成功；如果是其他状态码，可能需要根据具体情况处理错误。

 if (response.IsSuccessStatusCode)
   {
       // 处理成功的响应
   }
   else
   {
       // 处理错误情况，可以读取响应内容来获取错误信息
       string errorMessage = await response.Content.ReadAsStringAsync();
       Console.WriteLine($"Error: {errorMessage}");
   }

4、处理响应内容

如果响应成功，根据响应数据的格式进行处理，API 返回的是 JSON 数据，可以使用“Newtonsoft.Json”库中的“JsonConvert”类将 JSON 字符串转换为相应的 C# 对象，假设天气 API 返回的数据结构如下：

 {
       "city": "Beijing",
       "temperature": "25°C",
       "weather": "Sunny"
   }

可以定义一个对应的 C# 类：

 public class WeatherInfo
   {
       public string City { get; set; }
       public string Temperature { get; set; }
       public string Weather { get; set; }
   }

然后使用“JsonConvert.DeserializeObject”方法将 JSON 字符串转换为“WeatherInfo”对象：

 string jsonResponse = await response.Content.ReadAsStringAsync();
   WeatherInfo weather = JsonConvert.DeserializeObject<WeatherInfo>(jsonResponse);
   Console.WriteLine($"City: {weather.City}, Temperature: {weather.Temperature}, Weather: {weather.Weather}");

三、示例代码归纳

以下是一个完整的在 C# 中调用 API 的示例代码，假设是调用一个简单的获取问候语的 API：

c# 怎么调用api

using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
class Program
{
    static async Task Main(string[] args)
    {
        string apiUrl = "https://api.example.com/greeting";
        string apiKey = "your_api_key_here";
        string requestUri = $"{apiUrl}?apiKey={apiKey}";
        HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, requestUri);
        request.Headers.Add("Accept", "application/json");
        using (HttpClient client = new HttpClient())
        {
            client.Timeout = TimeSpan.FromSeconds(10);
            Task<HttpResponseMessage> responseTask = client.SendAsync(request);
            HttpResponseMessage response = await responseTask;
            if (response.IsSuccessStatusCode)
            {
                string jsonResponse = await response.Content.ReadAsStringAsync();
                JObject greetingObject = JObject.Parse(jsonResponse);
                string greeting = greetingObject["greeting"].ToString();
                Console.WriteLine(greeting);
            }
            else
            {
                string errorMessage = await response.Content.ReadAsStringAsync();
                Console.WriteLine($"Error: {errorMessage}");
            }
        }
    }
}

这个示例中，我们调用了一个假设的获取问候语的 API，通过 API Key 进行认证，然后解析返回的 JSON 数据并输出问候语。