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

来源:这里教程网 时间:2026-02-21 17:31:15 作者:

.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] 定义基路径:

[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。实际开发中建议优先使用属性路由,它更直观、可控性强,也更适合现代前后端分离架构。

相关推荐

热文推荐