0

0

c# 如何调用 rest api

幻夢星雲

幻夢星雲

发布时间:2026-01-15 07:45:26

|

493人浏览过

|

来源于php中文网

原创

最稳妥的 HttpClient 用法是复用而非每次新建,应声明为静态字段或 DI 单例;GET 请求需用 EnsureSuccessStatusCode() 处理错误状态码,POST JSON 必须设置 Content-Type,认证信息应通过 DefaultRequestHeaders 预设,错误处理需兼顾网络异常与 HTTP 状态码。

c# 如何调用 rest api

HttpClient 发起 GET 请求最稳妥

直接 new HttpClient 是常见错误起点——它本应复用,而非每次请求都新建。长期运行的服务若频繁创建销毁,会耗尽 socket 连接,触发 SocketExceptionHttpRequestException: Connection refused。推荐将 HttpClient 声明为静态字段或通过 DI 注册为单例。

基础 GET 示例:

var client = new HttpClient();
var response = await client.GetAsync("https://api.example.com/users");
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
  • EnsureSuccessStatusCode() 会抛出异常(如 404/500),避免手动检查 response.IsSuccessStatusCode
  • 若需设置超时,用 client.Timeout = TimeSpan.FromSeconds(10);,别在 GetAsync 外套 Task.Wait()Task.Result
  • GET 参数建议用 Uri.EscapeDataString() 手动拼接,或借助 FormUrlEncodedContent + PostAsync 模拟(不推荐);更安全的是用 HttpClient.BaseAddressstring.Concat() 构建完整 URI

POST JSON 数据必须设对 Content-Type

发 JSON 到 REST API 时,漏设 Content-Type: application/json 是 400 Bad Request 的头号原因。.NET 6+ 可用 JsonSerializer.SerializeToUtf8Bytes() 避免字符串编码开销;老版本建议用 StringContent 并显式指定编码。

示例(兼容 .NET 5+):

本地宝团购导航网站
本地宝团购导航网站

本地宝团购导航网站v1.2是由本地宝提供API接口调取团购数据,使用本程不用管理接口、数据采集,只需将程序放在网站某文件夹或域名下。程序是经过SEO优化,对提升网站流量有很大帮助,如果你的网站支持rewrite伪静态的话,你可以开启伪静态功能。 后台使用 后台地址:http://域名/admin 帐号密码:jiahai jiahai

下载
var client = new HttpClient();
var data = new { name = "Alice", email = "a@example.com" };
var json = JsonSerializer.Serialize(data);
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.example.com/users", content);
  • 不要用 content.Headers.ContentType = new MediaTypeHeaderValue(...) 覆盖 StringContent 构造时已设的类型
  • 若 API 要求 application/json; charset=utf-8StringContent 默认已包含,无需额外处理
  • 大对象 POST 建议用 StreamContent + FileStream 流式上传,避免内存峰值

带认证的请求要小心 header 注入时机

Bearer Token、API Key 等认证信息必须在发起请求前写入 client.DefaultRequestHeaders,而不是每次调用 PostAsync 时临时加——后者在并发场景下可能被覆盖或遗漏。

  • Token 过期需刷新?别在 DefaultRequestHeaders.Authorization 里硬编码,改用 DelegatingHandler 拦截重试逻辑
  • Basic Auth 推荐用 Convert.ToBase64String(Encoding.ASCII.GetBytes($"{user}:{pass}")) 生成 credential,再设为 client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", base64)
  • 某些 API(如 GitHub)要求 User-Agent header,漏掉会返回 403;可统一加client.DefaultRequestHeaders.UserAgent.ParseAdd("myapp/1.0")

错误处理不能只靠 try-catch

HttpRequestException 只覆盖网络层失败(DNS 错、连接断),但 HTTP 状态码如 401、422、503 会进到 response.IsSuccessStatusCode == false 分支。忽略这点,会导致业务逻辑把错误响应当成功数据解析。

  • 统一检查 response.StatusCode:401 走登录刷新,422 解析 response.Content 提取 errors 字段,503 可考虑指数退避重试
  • 反序列化前务必确认 response.Content.Headers.ContentType?.MediaType == "application/json",否则 JsonSerializer.Deserialize() 可能抛 JsonException
  • 日志中记录 response.RequestMessage?.RequestUriresponse.StatusCode,但切勿打 response.Content.ReadAsStringAsync() 的原始响应体(含敏感数据或超大 payload)
实际集成时,最难缠的是第三方 API 文档写得模糊:比如声称“返回 JSON”,实际空 body 时没设 Content-Type;或要求 PUT 但实现只认 PATCH。这些没法靠通用封装解决,得留一两个裸 HttpClient.SendAsync() 调用点,方便快速验证 raw request/response。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

411

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

532

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

315

2023.08.02

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6084

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

803

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

1059

2023.12.21

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

63

2026.01.14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号