新闻中心

.NET Web API如何配置路由(Routing)_路由配置方法详解

2025-11-21
浏览次数:
返回列表
.NET Web API 路由通过MapControllers()启用,支持传统路由和属性路由;传统路由在Program.cs中配置全局模板,如"api/{controller}/{action}/{id?}",适用于固定结构;属性路由使用[Route]、[HttpGet]等特性直接在控制器或方法上定义路径,更灵活且符合RESTful设计,推荐用于现代开发。

.net web api如何配置路由(routing)_路由配置方法详解

.NET Web API 的路由(Routing)是决定 HTTP 请求如何映射到控制器中具体操作方法的核心机制。合理配置路由,可以让 API 接口结构清晰、易于维护,并支持 RESTful 风格设计。本文将详细介绍 .NET 中 Web API 路由的配置方式,包括传统路由、属性路由以及混合使用场景。

启用路由与基础配置

在 .NET Web API 项目中,路由通常在 Program.csStartup.cs 文件中配置。从 .NET 6 开始,推荐在 Program.cs 中进行集中配置。

要启用 Web API 路由,需确保调用 MapControllers() 方法:

builder.Services.AddControllers();
app.MapControllers();

这行代码启用了基于控制器的路由,并自动扫描带有 [ApiController] 特性的控制器类。

传统路由(Convention-based Routing)

传统路由通过在程序启动时定义 URL 模板来匹配请求。适用于早期 ASP.NET Web API 项目,现在仍可使用。

示例:配置一个默认路由模板

app.UseRouting();
app.UseEndpoints(endpoints =>
{
   endpoints.MapControllerRoute(
      name: "default",
      pattern: "api/{controller}/{action}/{id?}"
   );
});
  • api/ 是所有 API 的前缀
  • {controller} 映射到控制器名称(不含 Controller 后缀)
  • {action} 映射到具体的方法名
  • id? 表示可选参数

例如,请求 GET /api/users/get/123 将调用 UsersController 中的 Get(int id) 方法。

属性路由(Attribute Routing)

属性路由是目前推荐的方式,通过在控制器或方法上添加 [Route]、[HttpGet] 等特性来定义路径,更加灵活且符合 RESTful 设计。

在控制器上使用 [Route] 定义基路径:

CA.LA CA.LA

第一款时尚产品在线设计平台,服装设计系统

CA.LA 94 查看详情 CA.LA [ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
   [HttpGet] // GET: api/users
   public IActionResult GetAll() => Ok();

   [HttpGet("{id}")] // GET: api/users/5
   public IActionResult GetById(int id) => Ok(id);

   [HttpPost] // POST: api/users
   public IActionResult Create([FromBody] User user) => Created("", user);
}
  • [controller] 自动替换为控制器名称(如 Users)
  • [action] 可用于插入方法名,但一般 RESTful 接口不建议暴露动作名
  • 每个方法可独立设置 HTTP 动词和路径参数

高级属性路由技巧

属性路由支持更复杂的路径结构和约束,提升接口可读性和安全性。

自定义路径:

[HttpGet("search/{keyword:minlength(2)}")] public IActionResult Search(string keyword)

这里加入了长度约束,确保 keyword 至少 2 个字符。

多路径支持:

[HttpGet("all")]
[HttpGet("list")]
public IActionResult GetAll()

同一个方法响应多个 URL。

版本化路由:

[Route("api/v1/[controller]")]

便于实现 API 版本控制。

基本上就这些。掌握传统路由和属性路由的配置方式,能让你更高效地构建结构清晰的 Web API。实际开发中建议优先使用属性路由,它更直观、可控性强,也更适合现代前后端分离架构。

以上就是.NET Web API如何配置路由(Routing)_路由配置方法详解的详细内容,更多请关注其它相关文章!


# app  # 网站建设说明怎么写  # 企业网站做网络推广  # seo建站一年赚多少钱  # 网站建设案例优帮云  # 解决问题  # 自定义  # 能让  # 中文网  # 相关文章  # 多个  # 有哪些  # 身份验证  # 适用于  # .net  # 路由  # 后端  # word  # 北京定制网站建设电源  # 石景山优化网站建设  # 网站优化设置软件免费  # 辛集网络产品营销推广哪家好  # 福州推广短视频营销服务费  # seo帮站网 


相关栏目: 【 科技资讯46185 】 【 网络学院92790


相关推荐: Win11截图该按哪些键 Win11截屏完整流程解析【教程】  Animex动漫社网入口地址 Animex动漫社网正版在线入口  TikTok搜索不到用户发布内容怎么办 TikTok用户内容搜索优化方法  XML中包含HTML标签导致解析错误? 正确嵌入非XML数据的两种方法  小红书商家版怎样在笔记嵌入商品卡路径_小红书商家版在笔记嵌入商品卡路径【挂载教程】  马斯克:Optimus 人形机器人复数形式为 Optimi  C#中解析不规范的HTML为XML 常见的坑与解决办法  Win11怎么关闭快速启动_Win11彻底关机设置教程  怎么在html里运行vbs脚本_html中运行vbs脚本方法【教程】  在J*a中如何开发简易电子商务商品管理系统_商品管理系统项目实战解析  12306几点到几点不能订票? | 官方最新系统维护时间全解析  Win11怎么开启高性能模式_Windows 11电源计划优化设置  Windows7怎么硬盘安装 Windows7提取ISO镜像到非系统盘并运行setup.exe实现硬盘直装【教程】  学习通在线学习平台 学习通网页版直接进入课程中心  AO3最新可访问网址 Archive of Our Own官方在线入口  一加Ace 6T实拍样张首次公布!李杰:主摄实力完全看齐4K档性能旗舰  Lar*el的路由模型绑定怎么用_Lar*el Route Model Binding简化控制器逻辑  邮政编码查询不到怎么办_邮政编码查询不到的常见原因与对策  J*aScript中安全有效地处理localStorage字符串数据  Angular Material 垂直步进器:实现底部到顶部排序的教程  windows10怎么关闭系统提示音_windows10彻底静音设置方法  抖音创作助手登录入口_抖音创作辅助工具官网直达  AO3官网镜像链接 Archive of Our Own同人文在线浏览  Go Martini框架:动态服务解码后的图片内容  Golang如何使用buffered channel提高性能_Golang buffered channel优化技巧  深入理解J*a合成构造器:何时以及为何阻止其生成  163邮箱注册官网 免费申请163个人邮箱  魅族20怎样在浏览器开无图省流_iPhone魅族20浏览器开无图省流【流量节省】  如何有效阻止外部脚本意外修改内联样式的高度属性  腾讯QQ邮箱官方网站_QQ邮箱网页版在线登录  怎样在Excel中做仪表盘_Excel仪表盘设计与关键指标展示方法  Linux如何构建多环境配置管理_Linux多环境配置方案  12306选座怎么选到商务座_12306商务座选择与配置说明  必由学登录入口 必由学官方网站在线访问链接  Tailwind CSS line-clamp 布局问题解析与修复指南  天猫2025双十一0点秒杀攻略 天猫爆款抢购时间  Python异步编程实践:使用Binance API构建实时交易数据流  深入理解字体排版:Adobe光学字偶距与CSS字偶距的差异与实现  PPT平滑切换怎么做 PPT炫酷“平滑”切换动画制作教程【必学】  qq游戏跨平台入口_qq游戏多设备同步登录  C++指针和引用有什么区别_C++内存管理核心概念深度解析  J*a里如何实现订单支付与库存同步功能_支付库存同步项目开发方法说明  批改网学生版PC登录 批改网官网登录系统入口  2025AO3夸克浏览器通道_AO3手机HTTPS安全入口分享  深入理解与实现最大堆的Heapify过程:常见错误与修正  铁路12306卧铺选择攻略 铁路12306下铺座位预定技巧  C++如何进行游戏物理模拟_使用Box2D库为C++游戏添加2D物理效果  夸克浏览器桌面版同步不了书签怎么处理 夸克浏览器跨设备同步异常解决方案  sublime如何处理大型CSV文件的列对齐_sublime高级表格编辑插件指南  如何在Promise链中有效终止错误处理后的执行 

搜索