C#中WebAPI接口开发_C#RESTful接口开发教程【必学】

酷晨姑娘_3261

酷晨姑娘_3261

2026-05-21

460人浏览

原创

直接用 dotnet new webapi 创建项目必须加 --no-https 避免 307 重定向;控制器需同时继承 controllerbase 并标注 [apicontroller];post 接收 json 时参数须加 [frombody]、dto 属性为 public、请求头含 content-type: application/json;推荐返回 actionresult 以支持状态码与 swagger 文档。

c#中webapi接口开发_c#restful接口开发教程【必学】

直接用 dotnet new webapi 创建项目,不加参数就跑起来,90% 的人会在 5 分钟内遇到 307 重定向、400 Bad Request 或 404 —— 这些不是代码写错了,而是默认配置和实际使用场景没对齐。

创建项目时必须加 --no-https

本地调试时,dotnet new webapi -n MyApi 默认启用 HTTPS 重定向。curl 或 Postman 发 http://localhost:5000/api/values 会卡在 307,接口“看似不通”。

  • 最省事:创建时就加 --no-https:dotnet new webapi --no-https -n MyApi
  • 已生成项目:删掉 app.UseHttpsRedirection() 和 app.UseHsts();再检查 Properties/launchSettings.json 里的 applicationUrl,删掉 https 那条(只留 http)
  • 别信“上线再配 HTTPS”——开发期就配错,上线时连调试路径都理不清

控制器必须同时满足两个硬性条件

缺一不可,否则路由识别失败或模型绑定静默失效:

C#
C#

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

下载
  • 继承 ControllerBase(不是 Controller),避免混入 View 相关方法
  • 顶部加 [ApiController] 特性,它才启用自动模型验证、绑定失败跳过、JSON 驼峰命名等 API 专用行为
  • 漏掉任一条件,常见现象是 GET 能返回数据,但 POST 总是 400 且 ModelState.IsValid 为 false 却查不到哪出错

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)

返回类型别用 IActionResult 或裸模型,选 ActionResult<t></t>

用错返回类型,Swagger 文档就废一半,状态码也难控制:

  • IActionResult:编译期无类型检查,Swagger 不知道成功响应长什么样
  • 裸 Task<weatherforecast></weatherforecast>:只能返回 200,没法主动返回 NotFound() 或 BadRequest()
  • ActionResult<weatherforecast></weatherforecast>:既能 return Ok(data),也能 return NotFound(),Swagger 自动推导响应 Schema
  • 示例:[HttpGet("{id}")] public ActionResult<weatherforecast> Get(int id)</weatherforecast> { ... }

最容易被忽略的是:[ApiController] 特性不只是“让 Swagger 能用”,它还强制执行参数绑定策略。一旦加了,所有未标注来源(如 [FromQuery])的参数都会按默认规则解析,而这个规则在 POST 场景下极易和你预期冲突。

大量免费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

952

5

什么是c#
什么是c#

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

2023.08.31

2631

3

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

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

2024.03.13

845

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

292

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

309

20

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习