asp.net web api

客官°小女子只卖身不卖艺 2022-08-24 14:23 168阅读 0赞

官方的地址:

http://www.asp.net/web-api

里面的资料很全,是学习的第一选择.建议多参考此资料

1.里面最简单直接的例子

http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api

# ASP.NET Web API 2 (C\#) 入门 #

由[迈克华士信][Link 1] | 2014 年 1 月 20 日

打印

HTTP 不只是为了生成 web 页面。它也是一个强大的平台建设公开服务和数据的 Api。HTTP 是简单、 灵活和无处不在。您能想到的几乎任何平台有一个 HTTP 库，因此，HTTP 服务可以到达范围广泛的客户端，包括浏览器、移动设备和传统的桌面应用程序。

ASP.NET Web API 是用于生成 web Api 在.NET 框架上的框架。在本教程中，您将使用 ASP.NET Web API 创建的 web API 返回的产品列表。前端的 web 页使用 jQuery 来显示结果。

![getstarted11.png_cdn_id_2014-02-06-001][]

[下载已完成的项目][Link 2].

## 要求 ##

本教程使用[Visual Studio 2013][].

## 创建一个 Web API 项目 ##

启动 Visual Studio 时，从**开始**页中选择**新的项目**。或者，从**文件**菜单中，选择**新建**，然后**项目**.

在**模板**窗格中，选择**已安装的模板**和展开**Visual C\#**节点。在**Visual C\#**中，选择**Web**。在项目模板的列表中，选择**ASP.NET Web 应用程序**。名称"ProductsApp"项目，然后单击**确定**.

![getstarted01.PNG_cdn_id_2014-02-06-001][]

在**新的 ASP.NET 项目**对话框中，选择的**空**模板。根据"添加文件夹和核心的参考文件"，检查**Web API**。单击**确定**.

![getstarted02.PNG_cdn_id_2014-02-06-001][]

您还可以创建一个 Web API 项目，利用"Web API"模板。Web API 模板使用 ASP.NET MVC 提供 API 的帮助页。我使用的空模板在本教程中因为我想要显示无 MVC Web API。一般情况下，你不需要知道 ASP.NET MVC 中使用 Web API。

## 添加模型 ##

*模型*是一个对象，表示您的应用程序中的数据。ASP.NET Web API 可以自动序列化您的模型到 JSON、 XML 或一些其他格式，然后将序列化的数据写入到 HTTP 响应消息的正文。只要客户端可以读取序列化格式，它可以反序列化该对象。大多数客户端可以解析 XML 或 JSON。此外，客户端可以表明哪一种格式它想要通过 HTTP 请求消息中设置的接受标头。

让我们首先创建一个简单的模型，它代表一种产品。

如果解决方案资源管理器已不可见，请单击**视图**菜单，然后选择**解决方案资源管理器**。在解决方案资源管理器中，右键单击模型文件夹。从上下文菜单中，选择**添加**，然后选择**类**.

![getstarted03.png_cdn_id_2014-02-06-001][]

命名类"Product"。将以下属性添加到`Product`类。

namespace ProductsApp.Models
    {
       
        public class Product
        {
       
            public int Id {
        get; set; }
            public string Name {
        get; set; }
            public string Category {
        get; set; }
            public decimal Price {
        get; set; }
        }
    }

## 添加控制器 ##

在 Web API 中，*控制器*是处理 HTTP 请求的对象。我们将添加一个控制器，可以返回由 ID 指定的单个产品的列表

**请注意**如果你使用了 ASP.NET MVC 中，您已熟悉控制器。Web API 控制器类似于 MVC 控制器，但是继承**ApiController**类，而不是**控制器**类。

在**解决方案资源管理器中**，右键单击控制器文件夹。选择**添加**，然后选择**控制器**.

![getstarted04.png_cdn_id_2014-02-06-001][]

在**添加脚手架**对话框中，选择**Web API 控制器-空**。单击**添加**.

![getstarted05.PNG_cdn_id_2014-02-06-001][]

在**添加控制器**对话框中，名称"ProductsController"的控制器。单击**添加**.

![getstarted06.PNG_cdn_id_2014-02-06-001][]

脚手架创建一个名为控制器文件夹中的 ProductsController.cs 文件。

![getstarted07.png_cdn_id_2014-02-06-001][]

你不需要放入一个文件夹命名为控制器的您的控制器。只是方便的方式来组织您的源文件的文件夹名称。

如果该文件尚未打开，请双击该文件以将其打开。此文件中的代码替换为以下内容：

using ProductsApp.Models;
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Net;
    using System.Web.Http;
    
    namespace ProductsApp.Controllers
    {
       
        public class ProductsController : ApiController
        {
       
            Product[] products = new Product[] 
            {
        
                new Product {
        Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1 }, 
                new Product {
        Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M }, 
                new Product {
        Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M } 
            };
    
            public IEnumerable<Product> GetAllProducts()
            {
       
                return products;
            }
    
            public IHttpActionResult GetProduct(int id)
            {
       
                var product = products.FirstOrDefault((p) => p.Id == id);
                if (product == null)
                {
       
                    return NotFound();
                }
                return Ok(product);
            }
        }
    }

为保持示例简单，产品都存储在一个固定的数组，在控制器类的内部。当然，在实际的应用中，将从数据库中查询或使用一些其他外部数据源。

控制器定义返回的产品的两种方法：

*  `GetAllProducts` 方法返回产品的完整列表作为  **IEnumerable<Product>** 类型。
 *  `GetProduct`方法查找单个产品由其 id。

就这么简单 ！你有工作 web API。每个控制器上的方法对应于一个或多个 Uri：

<table> 
 <thead> 
  <tr> 
   <th>控制器的方法</th> 
   <th>URI</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>GetAllProducts</td> 
   <td>/api/products</td> 
  </tr> 
  <tr> 
   <td>GetProduct</td> 
   <td>/api/products/<em>id</em></td> 
  </tr> 
 </tbody> 
</table>

对于`GetProduct`的方法，URI 中的*id*是一个占位符。例如，若要获得具有 ID 为 5 的产品，URI 是`api/products/5`.

有关 Web API 如何将 HTTP 请求路由到控制器方法的详细信息，请参见[在 ASP.NET Web API 中的路由][ASP.NET Web API].

## 调用与 Javascript 和 jQuery 的 Web API ##

在本节中，我们将添加一个 HTML 页，使用 AJAX 调用 web API。我们会使用 jQuery，以使 AJAX 调用，并更新该页面的结果。

在解决方案资源管理器中，右键单击该项目并选择**添加**，然后选择**新项目**.

![getstarted08.png_cdn_id_2014-02-06-001][]

在**添加新项**对话框中，选择下**Visual C\#**中， **Web**节点，然后选择**HTML 页面**项目。命名"index.html"页。

![getstarted09.png_cdn_id_2014-02-06-001][]

用以下内容替换此文件中的所有内容：

<!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml">
    <head>
      <title>Product App</title>
    </head>
    <body>
    
      <div>
        <h2>All Products</h2>
        <ul id="products" />
      </div>
      <div>
        <h2>Search by ID</h2>
        <input type="text" id="prodId" size="5" />
        <input type="button" value="Search" onclick="find();" />
        <p id="product" />
      </div>
    
      <script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-2.0.3.min.js"></script>
      <script>
        var uri = 'api/products';
    
        $(document).ready(function () {
       
          // Send an AJAX request
          $.getJSON(uri)
              .done(function (data) {
       
                // On success, 'data' contains a list of products.
                $.each(data, function (key, item) {
       
                  // Add a list item for the product.
                  $('<li>', {
        text: formatItem(item) }).appendTo($('#products'));
                });
              });
        });
    
        function formatItem(item) {
       
          return item.Name + ': $' + item.Price;
        }
    
        function find() {
       
          var id = $('#prodId').val();
          $.getJSON(uri + '/' + id)
              .done(function (data) {
       
                $('#product').text(formatItem(data));
              })
              .fail(function (jqXHR, textStatus, err) {
       
                $('#product').text('Error: ' + err);
              });
        }
      </script>
    </body>
    </html>

有几种方法来获取 jQuery。在此示例中，使用[Microsoft Ajax CDN][]。您还可以下载它从[http://jquery.com/][http_jquery.com]和 ASP.NET"Web API"项目模板包括 jQuery 以及。

### 获取产品的列表 ###

若要获取产品的列表，请向“api/products”发送一个 HTTP GET 请求。

JQuery [getJSON][]函数会发送一个 AJAX 请求。对于响应包含的 JSON 对象的数组。`done`函数指定如果请求成功，则调用的回调。在回调中，我们用的产品信息更新 DOM。

$(document).ready(function () {
       
        // Send an AJAX request
        $.getJSON(apiUrl)
            .done(function (data) {
       
                // On success, 'data' contains a list of products.
                $.each(data, function (key, item) {
       
                    // Add a list item for the product.
                    $('<li>', {
        text: formatItem(item) }).appendTo($('#products'));
                });
            });
    });

### 获得产品的 ID ###

若要获取产品的 ID，发送 HTTP GET 请求到"/ api/产品*id*"，其中*id*是产品 id。

我们仍然调用 `getJSON` 发送 AJAX 请求，但这次我们将 ID 放在请求 URI 中。来自此请求的响应是一个单一产品的 JSON 表示。

## 运行应用程序 ##

按 F5 启动调试应用程序。在 web 页应如下所示：

![getstarted10.png_cdn_id_2014-02-06-001][]

若要获取产品的 ID，输入了 ID 并单击搜索：

![getstarted11.png_cdn_id_2014-02-06-001][]

如果您输入无效的 ID，则服务器返回 HTTP 错误：

![getstarted12.png_cdn_id_2014-02-06-001][]

## 使用 f12 键以查看 HTTP 请求和响应 ##

当您正在使用 HTTP 服务时，它可以看到 HTTP 请求和请求消息非常有用。你可以通过互联网资源管理器中 9 中使用 F12 开发人员工具。从互联网资源管理器 9，按**f12 键**以打开工具。单击**网络**选项卡，然后按**开始捕获**。现在回到 web 页，请按**F5**重新加载该 web 页。互联网资源管理器中将捕获浏览器和 web 服务器之间的 HTTP 通信。摘要视图显示页的所有网络通信：

![webapi_getstarted12.png_cdn_id_2014-02-06-001][]

找到对应的条目相对 uri"api/产品 /"。选择此项，然后单击**转到详细信息视图**。在详细信息视图中，有选项卡以查看请求和响应的邮件标题和正文。例如，如果您单击**请求标头**选项卡，您可以在接受标头中看到客户端请求的“application/json”。

![webapi_getstarted13.png_cdn_id_2014-02-06-001][]

如果您单击响应正文选项卡，您可以看到如何产品列表中被序列化为 JSON。其他浏览器都有类似的功能。[提琴手][Link 3]，web 调试代理是另一个有用的工具。你可以使用的提琴手以查看您的 HTTP 流量，并撰写 HTTP 请求，请求，为您提供在请求中的 HTTP 标头的完全控制。

## 后续步骤 ##

*  有关支持 POST、PUT 和 DELETE 操作的 HTTP 服务的更完整示例，请参阅[创建支持 CRUD 操作的 Web API][CRUD _ Web API].
 *  有关创建 HTTP 服务流体和响应的 web 应用程序的更多信息，请参见[ASP.NET 单页面应用程序][ASP.NET].
 *  您可以使您的 web API 可用在互联网上通过将它部署到承载的提供程序。Microsoft 提供了免费虚拟主机达 10 中的网站一个[免费的 Windows Azure 试用帐户][Windows Azure]。有关如何将 Visual Studio web 项目部署到 Windows Azure Web 站点的信息，请参阅[部署到 Windows Azure 网站 ASP.NET Web 应用程序][Windows Azure _ ASP.NET Web].
 *   
    
    ## 作者信息 ##
    
    ![Mike Wasson][]
    
    **迈克华士信**— — 迈克华士信是在微软的程序员-作家。

[Link 1]: http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api#author-36870
[getstarted11.png_cdn_id_2014-02-06-001]: http://i2.asp.net/media/4410109/getstarted11.png?cdn_id=2014-02-06-001
[Link 2]: http://code.msdn.microsoft.com/ASP-NET-Web-API-Tutorial-8d2588b1
[Visual Studio 2013]: http://go.microsoft.com/fwlink/?LinkId=306566
[getstarted01.PNG_cdn_id_2014-02-06-001]: http://i2.asp.net/media/4410043/getstarted01.PNG?cdn_id=2014-02-06-001
[getstarted02.PNG_cdn_id_2014-02-06-001]: http://i2.asp.net/media/4410055/getstarted02.PNG?cdn_id=2014-02-06-001
[getstarted03.png_cdn_id_2014-02-06-001]: http://i3.asp.net/media/4410061/getstarted03.png?cdn_id=2014-02-06-001
[getstarted04.png_cdn_id_2014-02-06-001]: http://i1.asp.net/media/4410067/getstarted04.png?cdn_id=2014-02-06-001
[getstarted05.PNG_cdn_id_2014-02-06-001]: http://i2.asp.net/media/4410073/getstarted05.PNG?cdn_id=2014-02-06-001
[getstarted06.PNG_cdn_id_2014-02-06-001]: http://i1.asp.net/media/4410079/getstarted06.PNG?cdn_id=2014-02-06-001
[getstarted07.png_cdn_id_2014-02-06-001]: http://i3.asp.net/media/4410085/getstarted07.png?cdn_id=2014-02-06-001
[ASP.NET Web API]: http://www.asp.net/web-api/overview/web-api-routing-and-actions/routing-in-aspnet-web-api
[getstarted08.png_cdn_id_2014-02-06-001]: http://i3.asp.net/media/4410091/getstarted08.png?cdn_id=2014-02-06-001
[getstarted09.png_cdn_id_2014-02-06-001]: http://i3.asp.net/media/4410097/getstarted09.png?cdn_id=2014-02-06-001
[Microsoft Ajax CDN]: http://www.asp.net/ajaxlibrary/cdn.ashx
[http_jquery.com]: http://jquery.com/
[getJSON]: http://api.jquery.com/jQuery.getJSON/
[getstarted10.png_cdn_id_2014-02-06-001]: http://i1.asp.net/media/4410103/getstarted10.png?cdn_id=2014-02-06-001
[getstarted12.png_cdn_id_2014-02-06-001]: http://i3.asp.net/media/4410115/getstarted12.png?cdn_id=2014-02-06-001
[webapi_getstarted12.png_cdn_id_2014-02-06-001]: http://i3.asp.net/media/3141890/webapi_getstarted12.png?cdn_id=2014-02-06-001
[webapi_getstarted13.png_cdn_id_2014-02-06-001]: http://i3.asp.net/media/3141896/webapi_getstarted13.png?cdn_id=2014-02-06-001
[Link 3]: http://www.fiddler2.com/fiddler2/
[CRUD _ Web API]: http://www.asp.net/web-api/overview/creating-web-apis/creating-a-web-api-that-supports-crud-operations
[ASP.NET]: http://www.asp.net/single-page-application
[Windows Azure]: http://www.windowsazure.com/en-us/pricing/free-trial/?WT.mc_id=A443DD604
[Windows Azure _ ASP.NET Web]: http://www.windowsazure.com/en-us/develop/net/tutorials/get-started/
[Mike Wasson]: http://i1.asp.net/media/3132378/mike-wasson.jpg?cdn_id=2014-02-06-001