Web开发之ASP.NET Web API 特性路由

1.WebApi是什么？

Web API是网络应用程序接口。包含了广泛的功能，网络应用通过API接口，可以实现存储服务、消息服务、计算服务等能力，利用这些能力可以进行开发出强大功能的web应用。

它可以对接各种客户端（浏览器，移动设备），构建http服务的框架。

 

2.ASP.NET Web API 是什么？

ASP.NET Web API 是一种框架，用于轻松构建可以访问多种客户端（包括浏览器和移动设备）的 HTTP 服务。 ASP.NET Web API 是一种用于在 .NET Framework 上构建 RESTful 应用程序的理想平台。

 

3.Web Service和Web API的比较？

Web Service：
1）、它是基于SOAP协议的，数据格式是XML
2）、只支持HTTP协议
3）、它不是开源的，但可以被任意一个了解XML的人使用
4）、它只能部署在IIS上
Web API：
1）、这是一个简单的构建HTTP服务的新框架
2）、在.net平台上Web API 是一个开源的、理想的、构建REST-ful 服务的技术
3）、不像WCF REST Service.它可以使用HTTP的全部特点（比如URIs、request/response头，缓存，版本控制，多种内容格式）
4）、它也支持MVC的特征，像路由、控制器、action、filter、模型绑定、控制反转（IOC）或依赖注入（DI），单元测试。
5）、它可以部署在应用程序和IIS上
6）、这是一个轻量级的框架，并且对限制带宽的设备，比如智能手机等支持的很好
7）、Response可以被Web API的MediaTypeFormatter转换成Json、XML 或者任何你想转换的格式。

 

4.http和soap的比较？

http:是一个客户端和服务器端请求和应答的标准（TCP）。http协议其目的是为了提供一种发布和接收htttp页面的方法

一http协议的客户端与服务器的交互：由HTTP客户端发起一个请求，建立一个到服务器指定端口（默认是80端口）的TCP连接。HTTP服务器则在那个端口监听客户端发送过来的请求。一旦收到请求，服务器（向客户端）发回一个状态行，比如”HTTP/1.1 200 OK”，和（响应的）消息，消息的消息体可能是请求的文件、错误消息、或者其它一些信息。

soap 协议：它描述了一种在分散或分布式的环境中如何交换信息的轻量级协议。soap在http协议的基础上，一个基于XML的协议。

不同：都是底层的通信协议，请求包的格式不同而已，soap包是XML格式,http纯文本格式。

关系：SOAP是个通信协议， SOAP在HTTP协议的基础上，把编写成XML的REQUEST参数, 放在HTTP BODY上提交个WEB SERVICE服务器(SERVLET，ASP什么的) 处理完成后，结果也写成XML作为RESPONSE送回用户端， 为了使用户端和WEB SERVICE可以相互对应，可以使用WSDL作为这种通信方式的描述文件，利用WSDL工具可以自动生成WS和用户端的框架文件，SOAP具备把复杂对象序列化捆绑到XML里去的能力。

 

 

5.WebApi路由是什么，路由机制是什么？

在Asp.Net Web API中，一个控制器就是一个处理HTTP请求的类，控制器的public 方法被叫做action方法或者简单的Aciton。当Web API接收到一个请求的时候，它将这个请求路由到一个Action。

在 web api 中 controller 是用来操作http 请求的。它里面的action 方法 对应不同的http 请求的方法。当 web api 收到一个http 请求的时候 ，路由表就会将请求映射到对应的action 方法中。

 

6.WebApi路由表？ 

在ASP.NET Web API中，一个控制器是处理HTTP请求的一个类。控制器的public方法称为动作方法（action methods）或简称为动作（action）。当Web API框架接收到一个请求时，它将这个请求路由到一个动作。

   为了确定调用哪一个动作，框架使用了一个路由表（routing table）。Visual Studio中Web API的项目模板会创建一个默认路由，这条路由是在WebApiConfig.cs文件中定义的，该文件位于App_Start目录。

   

public static void Register(HttpConfiguration config)
        {
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
 
            config.EnableSystemDiagnosticsTracing();
        }
   路由表中的每一个条目都包含一个路由模板（route template）。Web API的默认路由模板是“api/{controller}/{id}”。在这个模板中，“api”是一个文字式路径片段，而{controller}和{id}则是占位符变量。

   当Web API框架接收一个HTTP请求时，它会试图根据路由表中的一个路由模板来匹配其URI。如果无路由匹配，客户端会接收到一个404（未找到）错误。例如，以下URI与这个默认路由的匹配：

/api/contacts
/api/contacts/1
/api/products/gizmo1
   在路由中使用“api”的原因是为了避免与ASP.NET MVC的路由冲突。通过这种方式，可以用“/contacts”进入一个MVC控制器，而“/api/contacts”进入一个Web API控制器。当然，如果你不喜欢这种约定，可以修改这个默认路由表。

   一旦找到了匹配路由，Web API便会选择相应的控制和动作：为了找到控制器，Web API会把“控制器”加到{controller}变量的值（意即，把URI中的“控制器”作为{controller}变量的值）。为了找到动作，Web API会考查HTTP方法，然后寻找一个名称以HTTP方法名开头的动作。例如，对于一个GET请求，Web API会查找一个以“Get…”开头的动作，如“GetProduct”或“GetAllProduct”等。这种约定仅运用于GET、POST、PUT和DELETE方法。通过把注解属性运用于控制器，你可以启用其它HTTP方法。后面会看到一个例子。路由模板中的其它占位变量，如{id}，被映射成动作参数。

 

 

7.MVC和web api的路由机制的比较？

MVC和web api的路由机制的主要区别是web api 使用的是http 方法而不是url 的路径

 

8.什么是基于约定路由？

WebApi默认的路由规则我们称作基于约定路由,很多时候我们使用RESTful风格的URI.简单的路由是没问题的，如 api/Products/{id}。

 

9.什么是web api特性路由？

如果资源之间存在嵌套关系：客户包含订单，书有作者属性等等。对于这种Uri，我们希望的路由是这样的：/costomers/{customerid}/orders 或 /costomers/{customerid}/orders/{orderid}

考虑到这只是某个Controller的路由格式，而我们会有很多个Controller，用基于约定路由显然不合适(要配置很多的路由)

使用特性路由就简单了，在action上加一个特性即可

[Route("customers/{customerId}/orders")]
public IEnumerable<Order> GetOrdersByCustomer(int customerId) { ... }

通过使用特性路由，我们还可以做API的版本控制

/api/v1/products
/api/v2/products

 

10.如何启用特性路由？

启用特性路由需要在配置过程中调用System.Web.HttpConfigurationExtensions类的MapHttpAttributeRoutes方法

using System.Web.Http;

namespace WebApplication
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API routes
            config.MapHttpAttributeRoutes();

            // Other Web API configuration not shown.
        }
    }
}

在WebApi中  项目模板是这样的

protected void Application_Start()
{
    WebApiConfig.Register(GlobalConfiguration.Configuration);
    //
}

如果要启用特性路由，需要改成如下代码

protected void Application_Start()
{
    GlobalConfiguration.Configure(WebApiConfig.Register);
    //。。。
}

 

11.什么是HttpMethod特性？

默认情况，WebApi会根据action的方法名前缀查找action(不区分大小写)，比如GetUsers，会匹配Get。通过在action上添加HttpMethod特性，可以覆盖action需要映射的Http Method。

可使用的特性包括：[HttpDelete],[HttpPost],[HttpHead],[HttpOptions],[HttpPatch],[HttpGet],[HttpPut]

通过AcceptVerbs特性，我们还可以指定非标准方法以及多个方法，如 [AcceptVerbs("MKCOL","GET","POST")]

 

12.什么是路由前缀？

通常情况下，一个Controller下的action会使用相似的路由模板，如

• [Route("api/books")]
• [Route("api/books/{id:int}")]
• [Route("api/books/{bookid}/authors")]

这时候可以为整个controller指定[RoutePrefix]特性，以使用共同的前缀，把[RoutePrefix("/api/books")]加到controller上，action的路由特性就变成这样：

• [Route("")]
• [Route("{id:int}")]
• [Route("{bookid}/authors")]

此外，路由前缀中也可以包含参数，如[RoutePrefix("api/{userid}/books")]

 

13.什么是路由约束？

路由约束让我们可以限制模板参数的匹配方式。一般的语法是 "{参数：约束类型}"：

[Route("users/{id:int}"]
public User GetUserById(int id) { ... }

[Route("users/{name}"]
public User GetUserByName(string name) { ... }

如果参数int，则选中第一个GetUserById，否则是GetUserByName。(跟方法定义的顺序无关)

如果要指定多个约束，需要用冒号间隔 [Route("users/{id:int:min(1)}")]

 

14.可选参数，默认值是指什么？

通过在参数约束后面添加一个问号，可以设定URI参数是可选的；也可以像普通方法那样指定默认值：

[Route("api/books/locale/{lcid:int?}")]
public IEnumerable<Book> GetBooksByLocale(int lcid = 1033) { ... }

[Route("api/books/locale/{lcid:int=1033}")]
public IEnumerable<Book> GetBooksByLocale(int lcid) { ... }

 这两者是等价的

 

15.路由名称是什么？

WebApi中，每一个路由都有一个名字，用于生成链接，并在放入Http响应中。（应该是用于重定向吧） 

例如对某个action A指定Name，[Route("api/books/{id}", Name="GetBookById")]

那么其他action B在需要返回这个action A的链接时，就可以这样使用

public HttpResponseMessage Post(Book book)
{
    var response = Request.CreateResponse(HttpStatusCode.Created);
    string uri = Url.Link("GetBookById", new { id = book.BookId });
    response.Headers.Location = new Uri(uri);
    return response;
}

 

 

16.路由顺序是什么？

路由顺序

通过设定特性[Route("xxx",RouteOrder=n)]可以指定路由的查找顺序

[Route("pending", RouteOrder = 1)]
public HttpResponseMessage GetPending() { ... }