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

在 .NET Web API 中,路由(Routing)决定了客户端请求如何映射到控制器中的具体操作方法。合理配置路由是构建清晰、可维护 API 的关键一步。.NET 支持两种主要的路由方式:传统基于约定的路由(Convention-based Routing)和属性路由(Attribute Routing)。下面介绍如何在项目中正确配置它们。
在 Program.cs 或 Startup.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);
}这样每个端点的路径都清晰可见,易于维护。
在 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 等),适合简单场景,但不如属性路由灵活。
常见技巧:
[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)的详细内容,更多请关注php中文网其它相关文章!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号