C#怎么使用Minimal API TypedResults_C#类型化返回结果教程【最新】

夏杰小哥_3401

夏杰小哥_3401

2026-05-07

381人浏览

原创

必须用 typedresults 替代 results,因其返回强类型 iresult 实现(如 ok),可被 .produces() 直接识别以生成准确 openapi 文档,支持单元测试直接断言属性,避免隐式转换和运行时错误;而 return new { } 或 string 仅固定返回 200 + text/plain 或 application/json,无法控制状态码与元数据。

c#怎么使用minimal api typedresults_c#类型化返回结果教程【最新】

Minimal API 中必须用 TypedResults 替代 Results,否则 OpenAPI 文档无法正确推导响应类型、单元测试难断言、运行时也容易因隐式转换出错。

为什么不能直接 return new { ... } 或 string?

直接返回 string 或匿名对象虽能跑通,但框架会按默认规则设 Content-Type(text/plain 或 application/json),且不带状态码语义和 OpenAPI 元数据。比如 app.MapGet("/ping", () => "ok") 永远是 200 + text/plain,想返回 204 或 404 就做不到。

  • string / Task<string></string>:强制 200 + text/plain,不可控
  • 匿名类型 / Task<t></t>(非 IResult):强制 200 + application/json,无状态码选择
  • 必须显式构造 IResult 实例,而 TypedResults 提供的是强类型实现类(如 Ok<user></user>),不是泛型接口

TypedResults.Ok 和 Results.Ok 的关键区别

TypedResults.Ok<user>()</user> 返回的是具体类型 Ok<user></user>,而 Results.Ok(new User()) 返回的是 IResult 接口——前者在编译期就锁定响应结构,后者到运行时才解析。

  • TypedResults.Ok<user>(user)</user> → 类型为 Ok<user></user>,可被 .Produces<user>()</user> 直接识别,Swagger 自动生成 200: User 定义
  • Results.Ok(user) → 类型为 IResult,需额外调用 .Produces<user>()</user> 才能补全文档,否则 Swagger 显示 200: object
  • 单元测试中,Ok<user></user> 可直接 cast 并断言 Value 属性;IResult 必须 await + ExecuteAsync + 模拟 HttpContext 才能测

常见 TypedResults 工厂方法及使用场景

优先选 TypedResults 下对应方法,避免混用 Results。所有方法名首字母大写,返回值类型即其名称(如 NotFound 返回 NotFound 类型)。

C#
C#

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

下载
  • TypedResults.Ok<t>(value)</t>:成功返回资源,自动设 200 + application/json + 正确 OpenAPI 响应体
  • TypedResults.Created<t>(string location, T value)</t>:POST 创建后返回 201,location 填路径如 $"/api/users/{id}"
  • TypedResults.NoContent():204,适合 DELETE 或无返回体的更新操作
  • TypedResults.NotFound() 或 TypedResults.NotFound(string detail):404,不带 body 用前者,带提示用后者
  • TypedResults.BadRequest<t>(T error)</t>:400,传入错误模型(如 ValidationFailure)

示例:app.MapGet("/users/{id}", (int id, IUserService svc) => { var u = svc.Get(id); return u is null ? TypedResults.NotFound() : TypedResults.Ok(u); });

Produces 和 WithName 必须配合 TypedResults 使用

TypedResults 自带类型信息,但 OpenAPI 文档生成仍需显式声明。漏掉 .Produces<t>()</t>,Swagger 就只显示 200: object;漏掉 .WithName("xxx"),接口在文档里就是 Get_123 这种随机名。

  • .Produces<user>()</user> 要写在 MapGet 链式调用末尾,且泛型参数必须和 TypedResults.Ok<user></user> 一致
  • .WithName("Users_GetById") 应紧接在路由定义后,用于 Swagger 标题和测试引用
  • 若返回多种状态(如 200/404),需链式调用多次 .Produces<t>()</t> 和 .ProducesStatus(404)

复杂点在于:同一个端点若用 TypedResults.NotFound() 和 TypedResults.Ok<user>()</user> 分支返回,.Produces<user>()</user> 只覆盖 200 分支,404 分支还得加 .ProducesStatus(404) —— 这个细节常被忽略,导致文档缺失错误状态码定义。

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

相关文章

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

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

下载

相关标签:

c# c#类

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

相关专题

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

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

2023.08.08

892

5

什么是c#
什么是c#

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

2023.08.31

2431

3

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

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

2024.03.13

825

8

C#Task用法
C#Task用法

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

2024.03.14

2595

11

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

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

2026.02.03

272

18

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

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

2026.02.06

369

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

289

20

C++类型转换方式
C++类型转换方式

本专题整合了C++类型转换相关内容,想了解更多相关内容,请阅读专题下面的文章。

2025.07.15

2062

23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Conan 2 Essentials 免费课程
Conan 2 Essentials 免费课程

共0课时 | 0人学习

CMake 与 Conan 集成实践
CMake 与 Conan 集成实践

共0课时 | 0人学习

Conan 2 高级依赖模型介绍
Conan 2 高级依赖模型介绍

共0课时 | 0人学习