.NET Web API如何配置路由(Routing)

启用属性路由是推荐做法,通过在Program.cs中调用app.MapControllers()并使用[Route]和HTTP特性(如[HttpGet])在控制器上定义精确路径,实现灵活、清晰的API路由管理。

.net web api如何配置路由(routing)

在 .NET Web API 中,路由(Routing)决定了客户端请求如何映射到控制器中的具体操作方法。合理配置路由是构建清晰、可维护 API 的关键一步。.NET 支持两种主要的路由方式:传统基于约定的路由(Convention-based Routing)和属性路由(Attribute Routing)。下面介绍如何在项目中正确配置它们。

启用属性路由(Recommended)

现代 .NET Web API 推荐使用属性路由,因为它更灵活、直观,能精确控制每条路由。

Program.csStartup.cs(取决于你使用的 .NET 版本)中,需要显式启用属性路由。

以 .NET 6+ 的 Program.cs 为例:

var builder = WebApplication.CreateBuilder(args);var app = builder.Build();// 启用 MVC 并添加控制器支持app.MapControllers(); // 这会启用属性路由app.Run();

然后在控制器或方法上使用 [Route][HttpGet] 等特性定义路径:

[ApiController][Route("api/[controller]")]public class ProductsController : ControllerBase{    [HttpGet] // GET: api/products    public IActionResult GetAll() => Ok(new[] { "Product1", "Product2" });    [HttpGet("{id}")] // GET: api/products/5    public IActionResult GetById(int id) => Ok($"Product {id}");    [HttpPost] // POST: api/products    public IActionResult Create([FromBody] string name) => CreatedAtAction(nameof(GetById), new { id = 1 }, name);}

这样每个端点的路径都清晰可见,易于维护。

配置传统路由(可选)

如果你希望使用基于约定的路由(比如 RESTful 风格自动匹配动作),可以在 MapControllers 之外手动添加传统路由模板。

Program.cs 中:

app.UseRouting();app.UseEndpoints(endpoints =>{    endpoints.MapControllerRoute(        name: "default",        pattern: "api/{controller}/{action}/{id?}",        defaults: new { controller = "Home", action = "Index" });});

注意:这种方式需要控制器中的方法名称与 HTTP 动作匹配(如 Get、Post 等),适合简单场景,但不如属性路由灵活。

混合使用与高级配置

你可以同时使用属性路由和传统路由,系统会按注册顺序进行匹配。

常见技巧:

版本化路由:通过前缀区分 API 版本

[Route("api/v1/[controller]")]public class ProductsController : ControllerBase { }

自定义约束:限制参数格式

[HttpGet("{id:int}")] // 只匹配整数public IActionResult GetById(int id)

多个路由映射同一方法

[HttpGet("products/all")][HttpGet("items")]public IActionResult GetAll() => Ok();

基本上就这些。只要在启动时调用 MapControllers(),并在控制器上使用 [Route] 和 HTTP 方法特性,就能让 Web API 正确响应请求。属性路由是当前最佳实践,推荐优先使用。

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

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1441563.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月17日 18:13:03
下一篇 2025年12月17日 18:13:09

相关推荐

发表回复

登录后才能评论
关注微信