C#怎么创建Web API_C#创建ASP.NET Web API教程【详解】

裘德小鎮的故事

裘德小鎮的故事

2026-05-08

276人浏览

原创

直接用 dotnet new webapi 创建项目时,应加 --no-https 参数避免 https 重定向问题,使用 .net 6+ minimal hosting 模式,控制器需继承 controllerbase 并标注 [apicontroller] 特性,post 接收 json 须用 [frombody] 且属性为 public,推荐返回类型为 actionresult 以兼顾状态码控制与 swagger 文档生成。

c#怎么创建web api_c#创建asp.net web api教程【详解】

直接用 dotnet new webapi 创建的项目,90% 的 404、400、跨域失败、字段名大小写异常,都不是框架问题,而是默认配置和显式约定没对齐。

dotnet new webapi 命令该加哪些参数

默认命令 dotnet new webapi -n MyApi 会启用 HTTPS 重定向、HSTS 和 Swagger,但开发调试时经常卡在 307 重定向或 Swagger 空白页。最稳妥的起步方式是:

  • --no-https:避免本地调试时因 HTTPS 配置不全导致请求被无限重定向
  • 不加 --framework net5.0:除非必须兼容旧版 Startup.cs 结构,否则新项目一律用 .NET 6+ Minimal Hosting(即单文件 Program.cs
  • 若需 Swagger,确保 Program.cs 中有这两行(模板默认已含):builder.Services.AddEndpointsApiExplorer()builder.Services.AddSwaggerGen()

[ApiController] 和 ControllerBase 是什么关系

控制器类必须同时满足两个条件才能被路由识别并启用 API 特性:

  • 继承 ControllerBase(不是 Controller),因为后者带 View 相关方法,纯 API 场景下多余且可能干扰依赖注入
  • 顶部标注 [ApiController] 特性,它会自动启用三件事:模型验证失败返回 400、绑定失败自动跳过、JSON 序列化默认驼峰命名

漏掉任一条件,比如只继承 ControllerBase 但没加特性,就会出现 GET 正常、POST 总是 400 Bad Request 却找不到原因的情况。

C函数速查手册(CHM版)
C函数速查手册(CHM版)

C函数速查手册(CHM版)

下载

POST 接收 JSON 数据总为 null 怎么办

这是新手最高频的绑定失败场景,本质是没满足三个硬性条件:

  • DTO 类中属性必须是 public,字段(field)或 private 属性无法被序列化器读取
  • 控制器方法参数必须显式标记 [FromBody],.NET 6+ 不再隐式尝试从 Body 绑定对象
  • 请求头必须包含 Content-Type: application/json,用 curl 测试时别漏掉 -H "Content-Type: application/json"

例如这个写法一定失败:public IActionResult Create(User user);正确写法是:public IActionResult Create([FromBody] User user)

ActionResult 为什么比 IActionResult 或 Task 更合适

选错返回类型会导致两种典型后果:Swagger 文档缺失响应结构,或无法主动控制 HTTP 状态码。

  • 只用 IActionResult:编译期无类型检查,Swagger 不知道成功时返回什么 JSON 结构
  • 只用 Task<weatherforecast></weatherforecast>:只能返回 200,遇到数据不存在时无法返回 NotFound(),前端收到空响应却以为是成功
  • ActionResult<weatherforecast></weatherforecast>:既能 return Ok(model),也能 return NotFound(),且 Swagger 自动推导 200 响应体 Schema

真正容易被忽略的是:即使你 100% 确信某接口永远有数据,业务逻辑也常会在中间加权限校验、缓存穿透判断等分支——这些地方一旦需要返回非 200,ActionResult<t></t> 就成了唯一安全选择。

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

相关专题

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

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

2023.08.08

528

5

什么是c#
什么是c#

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

2023.08.31

1180

3

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

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

2024.03.13

556

8

C#Task用法
C#Task用法

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

2024.03.14

1051

11

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

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

2026.02.03

148

18

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

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

2026.02.06

203

20

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

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

2026.03.11

526

24

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

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

2026.04.13

138

20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
RabbitMQ 教程手册
RabbitMQ 教程手册

共0课时 | 0人学习

Linux man-pages 项目
Linux man-pages 项目

共0课时 | 0人学习

C# 教程
C# 教程

共94课时 | 20.2万人学习