讲师中心 微信公众号
AI工具推荐 视频效率加速

c# 开发web api 教程

星枫酱_4736

星枫酱_4736

发布时间:2026-02-17 03:45:24

|

714人浏览过

|

来源于php中文网

原创

ASP.NET Core Web API 关键点:用 ControllerBase 而非 Controller;必须显式标注 [FromQuery]/[FromBody]/[FromRoute];JSON 字段名需统一配置 PropertyNamingPolicy;CORS 中间件须在 UseRouting 后、UseEndpoints 前注册。

c# 开发web api 教程

直接用 ASP.NET Core 创建 Web API,别从“新建项目→选模板→F5运行”开始讲起——那不是教程,是向导。你真正卡住的地方,通常是路由没生效、模型绑定失败、跨域被拦、或者返回的 JSON 字段名不对。

Controller 继承 ControllerBase 而不是 Controller

如果你只需要返回 JSON(比如前端调用的纯 API),ControllerBase 更干净:它不带 View()、PartialView() 这些 MVC 专属方法,编译期就能防误用。

常见错误:手抖继承了 Controller,结果 IDE 提示 ViewBag 可用,但你根本不需要——这会悄悄增加不必要的依赖和内存开销。

  • API 控制器一律用 [ApiController] 特性标记
  • ControllerBase 默认启用模型验证失败自动返回 400 Bad Request,不用自己写 if (!ModelState.IsValid) return BadRequest();
  • 如果后续真要混用 View(比如管理后台页面),再改继承关系,而不是一开始贪方便选错基类

[FromQuery]、[FromBody]、[FromRoute] 必须显式声明

ASP.NET Core 不再默认猜测参数来源。不加特性,string id 会被当成 [FromQuery],而 MyDto dto 会被当成 [FromBody]——但这个“默认规则”极易被忽略,导致 POST 请求体为空、GET 参数收不到。

真实踩坑场景:前端发 POST /api/users 带 JSON,后端方法写成

public IActionResult Create(User user)
,结果 user 始终为 null,因为没加 [FromBody]。

C#
C#

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

下载
  • 查询参数(URL ?a=1&b=2)→ 用 [FromQuery]
  • JSON/XML 请求体 → 用 [FromBody](且一个方法最多一个)
  • 路由段值(如 /api/users/{id})→ 用 [FromRoute] 或直接写在路由模板里
  • 表单数据(application/x-www-form-urlencoded)→ 用 [FromForm],别指望 [FromBody] 能解析它

返回 JSON 时字段名大小写不一致?检查 JsonSerializerOptions.PropertyNamingPolicy

默认情况下,.NET 6+ 使用 JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase,所以 C# 类的 UserName 会序列化成 userName。但如果你手动 new JsonSerializerOptions() 却没设这个,或用了旧版 Newtonsoft.Json(JsonProperty 特性没生效),字段名就可能全大写或全小写,前端解包失败。

典型错误现象:Postman 看响应是 {"UserName":"abc"},但 Axios 收到的是 undefined,因为 JS 解构写了 const { userName } = res.data。

  • 全局配置(推荐):在 Program.cs 里加
    builder.Services.ConfigureHttpJsonOptions(options => { options.SerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase; });
  • 局部覆盖:用 JsonResult 构造时传入自定义 JsonSerializerOptions
  • 别混用 System.Text.Json 和 Newtonsoft.Json 的配置——它们互不识别对方的特性

CORS 报错 “No 'Access-Control-Allow-Origin' header”?别只在控制器上加 [EnableCors]

很多人加了 [EnableCors("MyPolicy")] 还是 403,因为中间件顺序错了。CORS 中间件必须在 UseRouting() 之后、UseEndpoints() 之前注册,否则预检请求(OPTIONS)根本进不到策略匹配环节。

更隐蔽的问题:策略名拼错、没允许凭据(AllowCredentials())、或者前端带了 Authorization 头但策略里没显式 WithHeaders("Authorization")。

  • 在 Program.cs 配置策略:
    builder.Services.AddCors(options => { options.AddPolicy("MyPolicy", policy => policy.WithOrigins("https://localhost:5173").AllowAnyMethod().AllowAnyHeader().AllowCredentials()); });
  • 中间件顺序必须是:UseRouting() → UseCors() → UseAuthentication() → UseAuthorization() → UseEndpoints()
  • 开发阶段可先用 AllowAnyOrigin() 排查,但上线前必须锁定具体域名

Web API 的难点不在“怎么写第一个接口”,而在“为什么这个接口在本地能跑,部署后就 404 或 500”。路由模板拼写、模型绑定源声明、JSON 序列化策略、CORS 中间件位置——这些地方一错,错误信息往往不指向根因。动手前先确认这四点,比反复重启 IIS 或重写 Controller 有用得多。

热门AI工具

更多
UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

709

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

644

2025.12.18

ThinkPHP中间件机制与请求拦截处理实践
ThinkPHP中间件机制与请求拦截处理实践

本专题围绕 ThinkPHP 中间件体系展开,深入讲解中间件的定义、注册与执行流程。内容包括全局中间件与路由中间件的区别、请求前后处理逻辑、自定义中间件开发以及权限验证与日志处理应用。通过实际案例,帮助开发者掌握中间件在项目中的核心作用与最佳实践。

458

2026.03.31

json数据格式
json数据格式

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

2275

2023.08.07

json是什么
json是什么

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

3722

2023.08.23

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

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

1236

2023.10.13

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

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

4299

2025.09.10

软件测试常用工具
软件测试常用工具

软件测试常用工具有Selenium、JUnit、Appium、JMeter、LoadRunner、Postman、TestNG、LoadUI、SoapUI、Cucumber和Robot Framework等等。测试人员可以根据具体的测试需求和技术栈选择适合的工具,提高测试效率和准确性 。

5110

2023.10.13

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

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

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn