Contact Manager Web API 示例[2] Web API Routing
联系人管理器web API是一个Asp.net web api示例程序,演示了通过ASP.NET Web API 公开联系信息,并允许您添加和删除联系人,示例地址http://code.msdn.microsoft.com/Contact-Manager-Web-API-0e8e373d。 Contact Manager Web API 示例[1]CRUD 操作 已经做了一个基本的介绍,本文主要介绍Web API Routing。
如果你已经熟悉 ASP.NET MVC,你会发现 Web API Routing(路由)与 MVC 非常类似。主要差异在 Web API 使用 HTTP Method ( GET, POST, PUT, DELETE ...) 而不是使用 URI 路径来选择 Action。你也可以在 Web API 里使用 MVC 样式的路由。以下讨论专注在 Web API 且可以没有 ASP.MVC 基础。
ROUTING TABLES, 路由表
在 ASP.NET Web API,一个 controller 是一个 class(类) 以处理 HTTP 请求(requests)。在 controller 里所有的公开方法(public methods)都称为 Action方法 或简称 Action。当 Web API Framework 接收到一个请求,它路由请求到一个 Action。 Framework 会使用路由表(Routing Table),决定那一个 Action 会被调用。如果你在 ASP.NET 里使用 Web API,路由表会定义在 Global.asax 档案中。默认使用 Visual Studio 去新增一个 Web API 项目,项目样版会建立默认路由给你:
config.Routes.MapHttpRoute(
"Default", // Route name
"{controller}/{id}/{ext}", // URL with parameters
new { id = RouteParameter.Optional, ext = RouteParameter.Optional } // Parameter defaults
);
注意,如果你使用 self-host Web API,你必须在 HttpSelfHostConfiguration对象 上直接设定路由表。
每个实体(entry)在路由表里都包含一个路由样板(route template)。Web API 的路由样板默认是 "api/{controller}/{id}",此样板里,"api" 是文字路径片段,{controller} 和 {id} 是定位参数。 当 Web API Framework 接收到一个 HTTP 请求,它会去尝试比对 URI 对路由表的路由样板之一, 如果没有符合的路由,Client 会收到一个 404 错误。例如,以下 URI 会符合默认路由:
· /api/contacts
· /api/contacts/1
当发现一个符合的路由,Web API 会选择 controller 与 action:
· 寻找 controller,Web API 新增 "Controller" 到 {controller} 变数的值。
· 寻找 action,Web API 查看 HTTP 方法,然后查看 action,哪一个名称的开始与是 HTTP 方法名称。例如,一个 GET 请求,Web API 会查看那一个 action 是以 "Get..." 开头,像是 "GetContact" 或 "GetAllContacts"。此惯例使用在 GET, POST, PUT, DELETE 方法。你也能在 controller 里使用属性(attributes)去启用其他 HTTP 方法。
· 在路由样板里其他定位变量,像是 {id},会对应至 action 的参数。
以下有一些可能 HTTP 请求:
Web API Routing and HTTP Method | |||
---|---|---|---|
HTTP Method |
URI路径 |
Action |
参数 |
GET |
/api/contacts |
GetAllContacts |
(无) |
GET |
/api/contacts/5 |
GetContactById |
5 |
DELETE |
/api/contacts/5 |
DeleteContact |
5 |
POST |
/api/contacts |
(无符合) |
留意 URI 的 {id} 段落,如果存在,会对应到 action 里的 id 参数。上述范例, controller 定义了两个 GET 方法,一个有 id 参数一个无 id 参数。另外,POST 请求会失败,因为在 controller 里没有定义 "Post..." 方法。
路由参数, ROUTING VARIATIONS
接下来我们讨论路由参数。
HTTP 方法, HTTP Methods
Web API 使用HTTP 方法的名称惯例(naming convention)来替代。你也可以明确在 action 方法上指定使用 HttpGet, HttpPost, HttpPut, HttpDelete 属性。 例如,以下的 Get 方法会对应至 GET 请求:
[HttpGet]
public HttpResponseMessage<Contact> Get(int id)
{
……
}
Action 名称的路由
在默认路由模板,Web API 使用 HTTP 方法来选择 action。不管如何,你也能建立一个 URI 含有 action 名称的路由。
config.Routes.MapHttpRoute(
"Default", // Route name
"/api/{controller}/{action}/{id}", // URL with parameters
new { id = RouteParameter.Optional} // Parameter defaults
);
此路由样板,在 controller 里的 action 方法会与 {action} 参数对应。使用此种路由样式,你必须明确指定允许属性在 HTTP 方法。例如,在 controller 里有一个 Details 方法:
[HttpGet]
public HttpResponseMessage<Contact> Details(int id)
{
}
一个 "/api/contacts/details/1" 的 GET 请求将会对应至 Details 方法。这种路由样式非常类似 ASP.NET MVC,或是接近一个 RPC-style API。在一个 RESTful API,你应该避免在 URI 使用动词(verbs),因为 URI 应该是定义资源而不是action。
非 Action
如果要预防一个 ACTION 被呼叫,可以使用 NONACTION 属性。这是一个信号跟 FRAMEWORK 说此方法不是一个 ACTION 方法。
[NonAction]
public Contact GetPrivateContact(int id)
{
……
}
参考资料
- Routing in ASP.NET Web API
- Attribute based routing in ASP.NET Web API
- Domain based routing with ASP.NET Web API
- Magical Web API action selector – HTTP-verb and action name dispatching in a single controller
- 一行Spark代码的诞生记(深度剖析Spark架构)
- Ray:AI的分布式系统
- Spring Boot 中使用 MongoDB 增删改查
- 来人啊给我炸了那个Java虚拟机No.46
- 机器学习虾扯淡之Logistic回归No.44
- 大数据计数原理1+0=1这你都不会算(一)No.47
- 机器学习虾扯蛋之SVD奇异值分解No.48
- 提高Spark姿势水平 No.73
- 好好玩的螺旋算法No.69
- linux学习第四十篇:访问日志不记录静态文件,访问日志切割,静态元素过期时间
- linux学习第四十一篇:配置防盗链,访问控制Directory,访问控制FilesMatch
- linux学习第四十二篇:限定某个目录禁止解析php, 限制user_agent,PHP相关配置
- 简易但不简单的配置中心No.79
- linux学习第四十三篇:LNMP架构介绍,mysql安装,php安装,Nginx介绍
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- 从JVM设计者的角度来看.class文件结构,一文弄懂.class文件的身份地位
- 抓包分析UDP,TCP和UDP的区别说不上五条就进来看看吧
- 学习|C#线程中AutoResetEvent的使用
- Httprouter—用go实现的高性能路由器
- Django-python最流行的web框架
- C++ 类的不同构造与三种引用
- C++继承、虚函数、RTTI、友元类、异常处理
- C++基本语法
- 抓包分析TCP三次握手四次挥手全过程,教你观看“多包运动”的正确姿势
- 抓包分析以太网帧和IP数据包,头部那么多东东用来干啥的,扫盲篇
- 一文洞悉 OSI和TCP/IP模型,理通所有协议,再也不用似懂非懂了
- 图解https演变以及各种加密解密过程一篇就够!(通俗易懂白话文)
- vs code 创建vue模版
- WebAssembly如何演进成为“浏览器第二编程语言”?
- SAP ABAP和Java的动态代理实现