C#如何实现API响应包装_C#统一返回格式封装教程【常用】

轻丽姑娘_4615

轻丽姑娘_4615

2026-05-14

881人浏览

原创

actionresult无法提供前端所需的code、message、data三层结构,必须封装泛型apiresult并配合actionfilterattribute全局包装,同时需显式标注producesresponsetype以确保swagger和nswag正确生成文档与客户端。

c#如何实现api响应包装_c#统一返回格式封装教程【常用】

直接用 ActionResult<t></t> 或 IActionResult 返回数据,前端收不到 Code、Message、Data 三层结构,没法做统一错误拦截和 loading 控制——必须封装自己的响应类型,并在序列化前介入。

定义泛型 ApiResult<tdata></tdata> 时三个关键约束

不加泛型约束或乱用 object,会导致反序列化后前端拿不到真实类型、值类型字段默认值崩掉、null 数据被忽略:

  • Data 字段必须声明为 TData?(C# 10+ 可空引用上下文开启时),且类定义加上 where TData : class 或 where TData : struct 显式区分;否则 ApiResult<int>.Data</int> 在未赋值时是 0 而非 null,掩盖业务空值语义
  • Code 别用枚举硬编码到类里,单独建静态类 ApiResultCode,比如 public static readonly int ParamError = 40001;,避免控制器里散落魔数
  • 构造函数中对 Message 赋默认值 = string.Empty,防止 JSON 序列化出 "Message": null,前端解构报错

全局自动包装要绕过 ASP.NET Core 的 ObjectResult 自动转换

中间件改 HttpResponse.Body 行不通——那时已经序列化完了。真正生效的位置是 Action 执行完、但还没进 JSON 输出器的阶段:

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • 写一个继承 ActionFilterAttribute 的过滤器,在 OnResultExecutionAsync 里判断 context.Result is ObjectResult or OkObjectResult
  • 跳过已包装过的响应:if (result.Value is ApiResult) 就直接 return,否则才用反射构造 ApiResult<t>.Success(value)</t>
  • 别碰 EmptyResult、StatusCodeResult、NotFoundResult ——这些是明确要返回原始 HTTP 状态码的,强行包会把 404 变成 200 + {Code:404},破坏 REST 语义

NSwag 生成客户端时如何保持包装结构不失真

NSwag 默认把 ApiResult<user></user> 当作顶层响应类型,但若你在 Controller 里写 return Ok(new User()),NSwag 会认为接口返回的是 User,而不是 ApiResult<user></user> —— 它看不到你过滤器里的包装逻辑:

  • 在 NSwagStudio 的 Response Wrapping 设置里勾选 Wrap Responses,并填入你的包装类全名,例如 Pgy_Wx.Common.ApiResult`1(注意反引号和数字 1 表示泛型)
  • 同时勾选 Use Response Wrapper for All Operations,否则只对标注了 [ProducesResponseType] 的方法生效
  • 生成的 TypeScript 客户端会自动把 data 字段解包一层,但 C# 客户端不会——你得手动在 NSwag 配置里加 GenerateClientInterfaces: true 并配合 UseHttpClient: true 才能获得强类型 ApiResult<t></t> 返回

最容易被忽略的是:过滤器包装后,Swagger UI 里看到的 Schema 还是裸 User,不是 ApiResult<user></user>。这不代表错了,只是 NSwag 没法自动推导运行时包装行为——你得靠 [ProducesResponseType(typeof(ApiResult<user>))]</user> 显式告诉它,否则文档和客户端代码就对不上。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

972

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

2731

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

865

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2615

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

312

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

389

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

611

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

309

20

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

2024.01.03

3696

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习