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

阳光穿透心脏的1/2处 2022-05-09 01:26 96阅读 0赞

路由有两种方式: 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
                    }
                });
            }
        }
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmd5dW1hbw_size_16_color_FFFFFF_t_70][]

使用\[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".  
运行结果:

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmd5dW1hbw_size_16_color_FFFFFF_t_70 1][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmd5dW1hbw_size_16_color_FFFFFF_t_70]: /images/20220509/e1beb63eed714494ab3a2de83d1fd7ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tpbmd5dW1hbw_size_16_color_FFFFFF_t_70 1]: /images/20220509/0d7487fc710e4fbdaee0d797b7a01422.png