从零开始学习 asp.net core 3.1 web api 后端api基础框架(五)-Routing 路由

最新推荐文章于 2025-06-25 14:53:03 发布

dbmos

最新推荐文章于 2025-06-25 14:53:03 发布

阅读量7.1k

点赞数 3

CC 4.0 BY-SA版权

分类专栏： .NetCore WebAPI 文章标签： .netcore3.1 Api

本文链接：https://blog.youkuaiyun.com/kingyumao/article/details/82896061

.NetCore WebAPI 专栏收录该内容

7 篇文章

订阅专栏

本文深入解析了路由配置的两种主要方式：基于约定的Convention-based和基于属性的attribute-based。重点介绍了WebAPI中推荐使用的attribute-based路由配置，包括Controller和Action级别的配置，以及常见的HTTP方法如GET、POST、PUT、PATCH和DELETE的使用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

路由有两种方式: Convention-based (按约定), attribute-based(基于路由属性配置的).
其中convention-based (基于约定的) 主要用于MVC (返回View或者Razor Page那种的).
Web api 推荐使用attribute-based.
这种基于属性配置的路由可以配置Controller或者Action级别, URI会根据Http method然后被匹配到一个controller里具体的action上.
常用的Http Method有:
Get, 查询, Attribute: HttpGet, 例如: '/api/product', '/api/product/1'
POST, 创建, HttpPost, '/api/product'
PUT 整体修改更新 HttpPut, '/api/product/1'
PATCH 部分更新, HttpPatch, '/api/product/1'
DELETE 删除, HttpDelete, '/api/product/1

namespace CoreBackend.Api.Controllers
{
    //[Route("api/product")]
    [Route("api/[controller]")]
    public class ProductController: Controller
    {
        [HttpGet]
        public JsonResult GetProducts()
        {
            return new JsonResult(new List<Product>
            {
                new Product
                {
                    Id = 1,
                    Name = "牛奶",
                    Price = 2.5f
                },
                new Product
                {
                    Id = 2,
                    Name = "面包",
                    Price = 4.5f
                }
            });
        }
    }
}

使用[Route("api/[controller]")], 它使得整个Controller下面所有action的URI前缀变成了"/api/product", 其中[controller]表示XxxController.cs中的Xxx(其实是小写).
也可以具体指定, [Route("api/product")], 这样做的好处是, 如果ProductController重构以后改名了, 只要不改Route里面的内容, 那么请求的地址不会发生变化.
然后在GetProducts方法上面, 写上HttpGet, 也可以写HttpGet(). 它里面还可以加参数,例如: HttpGet("all"), 那么这个Action的请求的地址就变成了 "/api/product/All".
运行结果: