了解Web API

Posted 2022-05-17 llsg

Web API是一个比较宽泛的概念。这里我们提到Web API特指ASP.NET Web API。

这篇文章中我们主要介绍Web API的主要功能以及与其他同类型框架的对比，最后通过一些相对复杂的实例展示如何通过Web API构建http服务，同时也展示了Visual Studio构建.net项目的各种强大。

 

什么是 Web API

官方定义如下，强调两个关键点，即可以对接各种客户端（浏览器，移动设备），构建http服务的框架。

ASP.NET Web API is a framework that makes it easy to build HTTP services that reach a broad range of clients, including browsers and mobile devices. ASP.NET Web API is an ideal platform for building RESTful applications on the .NET Framework.

Web API在ASP.NET完整框架中地位如下图，与SignalR一起同为构建Service的框架。Web API负责构建http常规服务，而SingalR主要负责的是构建实时服务，例如股票，聊天室，在线游戏等实时性要求比较高的服务。

 

为什么要用 Web API

Web API最重要的是可以构建面向各种客户端的服务。另外与WCF REST Service不同在于，Web API利用Http协议的各个方面来表达服务(例如 URI/request response header/caching/versioning/content format)，因此就省掉很多配置。

 

当你遇到以下这些情况的时候，就可以考虑使用Web API了。

• 需要Web Service但是不需要SOAP
• 需要在已有的WCF服务基础上建立non-soap-based http服务
• 只想发布一些简单的Http服务，不想使用相对复杂的WCF配置
• 发布的服务可能会被带宽受限的设备访问
• 希望使用开源框架，关键时候可以自己调试或者自定义一下框架

功能简介

Web API的主要功能

1. 支持基于Http verb (GET, POST, PUT, DELETE)的CRUD (create, retrieve, update, delete)操作

    通过不同的http动作表达不同的含义，这样就不需要暴露多个API来支持这些基本操作。

2. 请求的回复通过Http Status Code表达不同含义，并且客户端可以通过Accept header来与服务器协商格式，例如你希望服务器返回JSON格式还是XML格式。

3. 请求的回复格式支持 JSON，XML，并且可以扩展添加其他格式。

4. 原生支持OData。

5. 支持Self-host或者IIS host。

6. 支持大多数MVC功能，例如Routing/Controller/Action Result/Filter/Model Builder/IOC Container/Dependency Injection。

Web API vs MVC

你可能会觉得Web API 与MVC很类似，他们有哪些不同之处呢？先上图，这就是他们最大的不同之处。

详细点说他们的区别，

• 1、Asp.net MVC 是用来创建返回视图（Views）与数据的Web应用，而Asp.net Web API是一种简单轻松地成熟的HTTP服务，它只返回数据，不返回视图（Views）,MVC主要用来构建网站，既关心数据也关心页面展示，而Web API只关注数据。

  2、Asp.net Web API可以通过.Net Framework来帮助我们构建REST-ful服务，而且他支持内容协商（根据客户端能接受的格式要求，返回相应的JSON，XML，ATOM），同时Asp.net Web API支持自我宿主（self-hosting），而MVC并不支持（只能宿主在IIS中）。

  3、Asp.net Web API可以返回特定的数据类型，比如JSON，XML，或者其他在请求头中定义的数据格式。而MVC只能利用Json Result返回JSON数据类型。

  4、Asp.net Web API 根据HTTP 谓语动词来映射Action，但MVC只是映射 Action 名称。

  5、Asp.net Web API 一种全新的框架，它是Asp.net Framework 核心库的一部分。在Asp.net Web API 一些存在MVC中的特征（model binding、filters、路由）是存在System.Web.Http程序集中，而MVC是存在System.Web.Mvc中。因此，Web API 可以和Asp.net一起使用，也可以做独立的服务层。

  6、如果在一个项目中融合Web API和MVC controller，用于处理复杂AJAX请求，这些请求可能返回JSON，XML或者其他数据格式。这就是Web API 自我宿主（Web API self-hosting）。

  7、如果融合MVC和Web API 控制器（controller），而且需要集成认证，这时，需要创建两个过滤器（Filters），一个MVC的，另一个Web API的，因为他们两个是不相同的。

  8、总之，WebApi在提供数据方面，是比MVC更加轻量的架构。

Web API vs WCF

发布服务在Web API和WCF之间该如何取舍呢？这里提供些简单地判断规则，

• 如果服务需要支持One Way Messaging/Message Queue/Duplex Communication，选择WCF
• 如果服务需要在TCP/Named Pipes/UDP (wcf 4.5)，选择WCF
• 如果服务需要在http协议上，并且希望利用http协议的各种功能，选择Web API
• 如果服务需要被各种客户端(特别是移动客户端)调用，选择Web API