ASP.NET Web API实践系列03,路由模版, 路由惯例, 路由设置

素颜马尾好姑娘i 2021-10-23 11:32 207阅读 0赞

ASP.NET Web API的路由和ASP.NET MVC相似，也是把路由放在RouteTable中的。可以在App\_Start文件夹中的WebApiConfig.cs中设置路由模版。默认的路由模版是：

routes.MapHttpRoute(

name: "API Default",

routeTemplate: "api/{controller}/{id}",

defaults: new { id = RouteParameter.Optional }

);

● 静态片段api，主要用来区分ASP.NET MVC的路由。  
● 为什么没有\{action\}？默认情况下，可以根据惯例找到Action，只要Action的名称符合惯例。  
● 占位符变量\{id\}映射Action的参数。

□ 根据惯例路由

对于GET,POST,PUT,DELETE请求，如果Action的名称以Get, Post, Put, Delete开头，这就是符合惯例，意味着在请求的url中无需指明Action，就可以路由到对应的Action中。

假设有这样的一个api控制器：

public class BooksController : ApiController

{

public void GetAllBooks(){}

public IEnumerable<Book> GetBookById(int id)

public HttpResponseMessage DeleteProduct(int id){}

}

● 浏览器输入：api/books 并且是Get请求

不带参数，由于GetAllBooks的名称以Get开头，符合惯例，这里会映射到GetAllBooks方法。

● 浏览器输入：api/books/8 并且是Get请求

带参数，会映射到GetBookById(int id)方法上。Web API会把字符串类型的8赋值给int类型的参数变量id。

● 浏览器输入：api/books/8 并且是DELETE请求  
映射到DeleteProduct(int id)

● 浏览器输入：api/books 并且是POST请求  
没有对应POST请求的Action。返回404状态码。

□ 根据HTTP方法路由

HttpGet, HttpPut, HttpPost, HttpDelete属性可以打在Action上面。

public class BooksController : ApiController

{

[HttpGet]

public Book FindBook(id){}

}

如果一个Action允许有多个HTTP方法，就使用AcceptVerbs属性。

public class BooksController ； ApiController

{

[AcceptVerbs("GET","HEAD")]

public Book FindProduct(id){}

}

□ 考虑Action的路由

我们可以在WebApiConfig.cs中设置路由的模版，把Action考虑进去。

routes.MapHttpRoute(

name: "ActionApi",

routeTemplate: "api/{controller}/{action}/{id}",

defaults: new { id = RouteParameter.Optional }

);

在api控制器中：

public class BooksController : ApiController

{

[HttpGet]

public string Details(int id);

}

此时，在浏览器中输入类似"api/books/details/8"的格式，才能映射到Details(int id)方法上。

还可以通过ActionName属性给Action取别名：

public class BooksController : ApiController

{

[ActionName("Sth")]

public HttpResposneMessage GetSth(int id);

}

如果不想让Action参与到路由中，可以使用NoAction属性。

public class BooksController : ApiController

{

[NonAction]

public string GetSomeData(){}

}

> 总结：在WebApiConfig.cs中定义的路由模版都被放到了RouteTable中了。在Action层面，如果想让请求路由到Action上，可以通过惯例、Http方法属性来实现。

转载于:https://www.cnblogs.com/darrenji/p/4049738.html

发表评论取消回复

表情：

评论列表（有 0 条评论，207人围观）

还没有评论，来说两句吧...

相关阅读

相关 IP路由__动态路由

.使用协议来查找网络并更新路由表的配置，就是动态路由。它比使用静态或默认路由方便，但它需要一定的路由器CPU处理时间和网络链接带宽。路由协议定义了路由器与相邻路由器通信时...

「爱情、让人受尽委屈。」/ 2024年04月20日 10:07/ 0 赞/ 15 阅读

相关 IP路由__静态路由

.静态路由的优缺点：　　优点：对于路由器的CPU没有管理性开销，它意味着如果你不使用动态路由选择的话，你可能应该购买更为便宜的路由器。在路由器之间没有带宽占用，它意味...

Dear 丶/ 2024年04月20日 10:05/ 0 赞/ 20 阅读

相关路由 vue-router 路由守卫路由重定向路由嵌套路由守卫路由命名路由懒加载

Vue Router 是 [Vue.js][] 官方的路由管理器。它和 Vue.js 的核心深度集成，让构建单页面应用变得易如反掌。包含的功能有：嵌套的路由/视图表

傷城~/ 2022年12月02日 01:04/ 0 赞/ 274 阅读

相关 Web API 路由

一、什么是路由？在计算机网络里，路由就是 > 路由（routing）就是通过互联的网络把信息从源地址传输到目的地址的活动。在Web API中意思也类似，就是将网络

深藏阁楼爱情的钟/ 2022年11月19日 01:18/ 0 赞/ 146 阅读

相关 vue 路由、嵌套路由、动态路由

简介路由就是一套映射规则，当url中的哈希值（\hash）改变时，路由会根据制定好的规则，展示对应的视图组件。 vue中的路由路径分为：相对路径（不带 ‘/’，会拼接

朴灿烈づ我的快乐病毒、/ 2022年10月29日 13:28/ 0 赞/ 320 阅读

相关 VUE —— 9、路由（二级路由、路由拦截）、axios

目录 8.二级路由（1）路由配置（2）二级路由渲染 9.路由拦截（12）axios 1.get请求 2.post请求 3.axios全局引入（很少用，用

小咪咪/ 2022年08月29日 12:54/ 0 赞/ 224 阅读

相关 react路由系列03___路由传值之params

此篇文章是基于 [react路由系列01\_\_\_ 在react脚手架里使用React-router(简单入门)][react_01_ _react_Reac

╰+攻爆jí腚メ/ 2021年12月11日 03:53/ 0 赞/ 248 阅读

相关 react路由系列02___ 二级路由

一、经过文章“[react路由系列01\_\_\_ 在react脚手架里使用React-router(简单入门)][react_01_ _react_React-router]

墨蓝/ 2021年12月11日 03:49/ 0 赞/ 357 阅读

相关 AngularJS路由系列(2)--刷新、查看路由,路由事件和URL格式，获取路由参数，路由的Resolve...

本系列探寻AngularJS的路由机制，在WebStorm下开发。主要包括： ● 刷新路由 ● 查看当前路由以及所有路由 ● 路由触发事件 ● 获取路

男娘i/ 2021年11月02日 12:32/ 0 赞/ 324 阅读

相关 ASP.NET Web API实践系列03,路由模版, 路由惯例, 路由设置

ASP.NET Web API的路由和ASP.NET MVC相似，也是把路由放在RouteTable中的。可以在App\_Start文件夹中的WebApiConfig.cs中设

素颜马尾好姑娘i/ 2021年10月23日 11:32/ 0 赞/ 208 阅读