.NET Web API如何配置路由（Routing）_路由配置方法详解-C#.Net教程-PHP中文网

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

畫卷琴夢

发布： 2025-11-21 08:43:02

原创

463人浏览过

.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.cs 或 Startup.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] 定义基路径：

AI-Text-Classifier

OpenAI官方出品，可以区分人工智能书写的文本和人类书写的文本

查看详情

[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);
}