0

0

.NET怎么调用一个RESTful API并处理返回的JSON

小老鼠

小老鼠

发布时间:2025-11-05 18:26:02

|

232人浏览过

|

来源于php中文网

原创

使用HttpClient调用RESTful API并结合System.Text.Json处理JSON数据,通过定义匹配JSON结构的C#类,可高效实现GET/POST请求、响应解析及错误处理。

.net怎么调用一个restful api并处理返回的json

.NET 调用 RESTful API 并处理 JSON 是常见的开发任务,通常使用 HttpClient 发起请求,配合 System.Text.Json 解析返回的 JSON 数据。下面是一个清晰、实用的实现方式。

1. 使用 HttpClient 发起 GET 请求

推荐将 HttpClient 作为单例或通过依赖注入使用,避免频繁创建导致资源浪费。

示例:获取用户信息

using System.Net.Http.Json;

var httpClient = new HttpClient(); try { var response = await httpClient.GetFromJsonAsync("https://www.php.cn/link/a89ab5f7e8a7f0419b5d07e00c521668"); if (response != null) { Console.WriteLine($"用户名: {response.Name}"); } } catch (HttpRequestException e) { Console.WriteLine($"请求失败: {e.Message}"); }

2. 定义匹配 JSON 结构的数据类

确保 C# 类的属性与 JSON 字段对应,可使用 [JsonPropertyName] 指定映射关系。

using System.Text.Json.Serialization;

public class User { public int Id { get; set; }

[JsonPropertyName("name")]
public string Name { get; set; }

[JsonPropertyName("email")]
public string Email { get; set; }

}

3. 处理 POST 请求并发送 JSON

使用 PostAsJsonAsync 自动序列化对象为 JSON 并提交。

var newUser = new User { Name = "张三", Email = "zhangsan@example.com" };

var response = await httpClient.PostAsJsonAsync("https://www.php.cn/link/93a819cbd635bd1505ef0f804c21cc2a", newUser);

Blogcast™
Blogcast™

BlogcastTM是一个文本转语音的工具,允许用户创建播客、视频、电子学习课程的音频和音频书籍,而无需录制。

下载

if (response.IsSuccessStatusCode) { var createdUser = await response.Content.ReadFromJsonAsync(); Console.WriteLine($"创建成功,ID: {createdUser.Id}"); }

4. 错误处理与状态码判断

不要忽略 HTTP 状态码,合理处理 4xx 和 5xx 错误。

  • 使用 EnsureSuccessStatusCode() 自动抛出异常(可选)
  • 或手动检查 response.IsSuccessStatusCode
  • 读取错误响应体时可用 ReadAsStringAsync()

var response = await httpClient.GetAsync("https://api.example.com/data");

if (!response.IsSuccessStatusCode) { var errorContent = await response.Content.ReadAsStringAsync(); Console.WriteLine($"错误: {response.StatusCode}, 内容: {errorContent}"); return; }

var data = await response.Content.ReadFromJsonAsync();

基本上就这些。只要配置好类型映射,用 HttpClient + System.Text.Json 就能高效完成调用和解析。

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

146

2025.11.26

json数据格式
json数据格式

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

412

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

310

2023.10.13

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

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

75

2025.09.10

http500解决方法
http500解决方法

http500解决方法有检查服务器日志、检查代码错误、检查服务器配置、检查文件和目录权限、检查资源不足、更新软件版本、重启服务器或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

370

2023.11.09

http请求415错误怎么解决
http请求415错误怎么解决

解决方法:1、检查请求头中的Content-Type;2、检查请求体中的数据格式;3、使用适当的编码格式;4、使用适当的请求方法;5、检查服务器端的支持情况。更多http请求415错误怎么解决的相关内容,可以阅读下面的文章。

411

2023.11.14

HTTP 503错误解决方法
HTTP 503错误解决方法

HTTP 503错误表示服务器暂时无法处理请求。想了解更多http错误代码的相关内容,可以阅读本专题下面的文章。

1953

2024.03.12

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

11

2026.01.20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 7.1万人学习

python编程入门系列图文教程
python编程入门系列图文教程

共65课时 | 24.6万人学习

vscode其实很简单
vscode其实很简单

共72课时 | 29万人学习

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

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