使用ASP.Net WebAPI构建REST服务(二)——路由
2016-07-16 19:55
537 查看
REST并没有像传统的RPC服务那样显式指定了服务器函数的访问路径,而是将URL根据一定的规则映射为服务函数入口,这个规则就称之为路由。Asp.Net WebAPI的路由方式和Asp.Net MVC是相同的,它支持两种路由方式,传统的路由映射和特性路由。 路由规则WebApiConfig.cs中定义,它的默认内容如下:
它默认注册了两种路由规则,第一行注册的是特性路由,第二行注册的则是传统的映射路由。默认情况下,由于我们没有编写特性路由规则,则是按照传统的Controller方式映射路由。
关于路由规则,MSDN文档ASP.NET 路由介绍得非常详细,但由于其介绍得太详细了,反而不容易得其门而入,这里我只拿默认的路由规则来简单但的介绍一下我的理解,它的uri格式是这样的"api/{controller}/{id}",其中id是可选的。拿前文的例子来说吧,
当我们对api/products地址进行访问的时候,系统则会首先找到名为ProductsController的控制器。
然后,根据访问方式查找函数,由于这里是Get操作,则查找Get开头的函数, 这里会找到Get()和Get(int id)两个重载版本。
最后,根据参数来匹配具体的函数,因为这里没有带参数id。因此匹配到了Get()函数,返回了所有的集合。
另外,这里也有几个常用的衍生规则:
根据操作方式找函数的时候,只需要匹配首部即可,因此我们编写函数的时候写成Get()和GetProduct()都是可以的。,
根据操作方式找函数的时候查找的时候不分大小写,因此写成Get()或get()都是可以的
当我们使用带参数的版本时候,也有几个需要注意的地方:
参数名不分大小写,我们写成id或ID都是可以的
参数名要求严格匹配的,我们写成ID2是不行的,此时则会匹配到错误的结果Get()
默认的规则虽然大多数的时候还是比较方便的,但是很多时候我们需要手动指定个性化的路由规则。例如,我们可以自定义一个按名称来查询的url:api/products/name=xxx。这个时候则可以用特性路由快速的实现了:
关于特性路由,MSDN原文Attribute Routing in ASP.NET MVC 5介绍得非常详细,国内也有非常不错的译文版本Attribute Routing in ASP.NET MVC 5 翻译及补充,这里就不做多少介绍了。
public static class WebApiConfig { public static void Register(HttpConfiguration config) { config.MapHttpAttributeRoutes(); config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } ); } }
它默认注册了两种路由规则,第一行注册的是特性路由,第二行注册的则是传统的映射路由。默认情况下,由于我们没有编写特性路由规则,则是按照传统的Controller方式映射路由。
关于路由规则,MSDN文档ASP.NET 路由介绍得非常详细,但由于其介绍得太详细了,反而不容易得其门而入,这里我只拿默认的路由规则来简单但的介绍一下我的理解,它的uri格式是这样的"api/{controller}/{id}",其中id是可选的。拿前文的例子来说吧,
当我们对api/products地址进行访问的时候,系统则会首先找到名为ProductsController的控制器。
然后,根据访问方式查找函数,由于这里是Get操作,则查找Get开头的函数, 这里会找到Get()和Get(int id)两个重载版本。
最后,根据参数来匹配具体的函数,因为这里没有带参数id。因此匹配到了Get()函数,返回了所有的集合。
另外,这里也有几个常用的衍生规则:
根据操作方式找函数的时候,只需要匹配首部即可,因此我们编写函数的时候写成Get()和GetProduct()都是可以的。,
根据操作方式找函数的时候查找的时候不分大小写,因此写成Get()或get()都是可以的
当我们使用带参数的版本时候,也有几个需要注意的地方:
参数名不分大小写,我们写成id或ID都是可以的
参数名要求严格匹配的,我们写成ID2是不行的,此时则会匹配到错误的结果Get()
默认的规则虽然大多数的时候还是比较方便的,但是很多时候我们需要手动指定个性化的路由规则。例如,我们可以自定义一个按名称来查询的url:api/products/name=xxx。这个时候则可以用特性路由快速的实现了:
[Route("api/{controller}/name={name}")] public IHttpActionResult GetByName(string name)
关于特性路由,MSDN原文Attribute Routing in ASP.NET MVC 5介绍得非常详细,国内也有非常不错的译文版本Attribute Routing in ASP.NET MVC 5 翻译及补充,这里就不做多少介绍了。
相关文章推荐
- 使用ASP.Net WebAPI构建REST服务(一)——简单的示例
- Use the Raspberry Pi as a DIY Surveillance camera
- Asp.net总结
- (翻译)从底层了解ASP.NET体系结构
- Asp.Net连接Mysql报错Out of sync with server
- asp.net EF 反向工程 CodeFirst 参数错误异常
- 香蕉派 banana pi BPI-M2+ 四核开发板 全志 allwinner H3方案
- asp.net使用mysql数据库
- 菜鸟级三层框架(EF+MVC)项目实战之 系列四 UI层ASP.NET MVC实现CRUD
- .aspx文件和.aspx.cs文件的区别与联系
- .aspx文件和.aspx.cs文件的区别与联系
- ASP.NET MVC进阶之路:深入理解依赖注入(DI)和控制反转(IOC)
- 【Dongle】【牛腩新闻发布系统】ASP无法识别
- ASP汉字转拼音函数的方法
- ASP.NET MVC4 导出Excel问题
- 使用jaspersoft创建jasper模板的经验总结
- ASP.NET MVC路由系统的核心对象介绍
- ASP.Net Core-依赖注入IoC
- asp.net获取文件夹下的所有文件
- ExtJS 6 Grid使用示例(ASP.NET MVC4 项目)