0

0

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

畫卷琴夢

畫卷琴夢

发布时间:2025-11-12 16:09:49

|

688人浏览过

|

来源于php中文网

原创

启用属性路由是推荐做法,通过在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);
}

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

Civitai
Civitai

AI艺术分享平台!海量SD资源和开源模型。

下载

配置传统路由(可选)

如果你希望使用基于约定的路由(比如 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 正确响应请求。属性路由是当前最佳实践,推荐优先使用。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

148

2025.11.26

http500解决方法
http500解决方法

http500解决方法有检查服务器日志、检查代码错误、检查服务器配置、检查文件和目录权限、检查资源不足、更新软件版本、重启服务器或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

395

2023.11.09

http请求415错误怎么解决
http请求415错误怎么解决

解决方法:1、检查请求头中的Content-Type;2、检查请求体中的数据格式;3、使用适当的编码格式;4、使用适当的请求方法;5、检查服务器端的支持情况。更多http请求415错误怎么解决的相关内容,可以阅读下面的文章。

416

2023.11.14

HTTP 503错误解决方法
HTTP 503错误解决方法

HTTP 503错误表示服务器暂时无法处理请求。想了解更多http错误代码的相关内容,可以阅读本专题下面的文章。

2087

2024.03.12

http与https有哪些区别
http与https有哪些区别

http与https的区别:1、协议安全性;2、连接方式;3、证书管理;4、连接状态;5、端口号;6、资源消耗;7、兼容性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2057

2024.08.16

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

17

2026.01.23

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

22

2026.01.23

yy漫画官方登录入口地址合集
yy漫画官方登录入口地址合集

本专题整合了yy漫画入口相关合集,阅读专题下面的文章了解更多详细内容。

91

2026.01.23

漫蛙最新入口地址汇总2026
漫蛙最新入口地址汇总2026

本专题整合了漫蛙最新入口地址大全,阅读专题下面的文章了解更多详细内容。

124

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java 教程
Java 教程

共578课时 | 50.6万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.0万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号