ASP.NET Web API 2（C＃）入门

在这篇文章中

作者：Mike Wasson

下载完成的项目

HTTP不仅仅是为了提供网页。它也是构建公开服务和数据的API的强大平台。HTTP简单，灵活，无所不在。几乎任何可以想到的平台都有一个HTTP库，所以HTTP服务可以覆盖广泛的客户端，包括浏览器，移动设备和传统的桌面应用程序。

ASP.NET Web API是在.NET Framework之上构建Web API的框架。在本教程中，您将使用ASP.NET Web API创建返回产品列表的Web API。

本教程中使用的软件版本

Visual Studio 2017
Web API 2

创建一个Web API项目

在本教程中，您将使用ASP.NET Web API创建返回产品列表的Web API。前端网页使用jQuery显示结果。

启动Visual Studio并从“ 开始”页面选择“ 新建项目 ” 。或者，从文件菜单中选择新建，然后选择项目。

在“ 模板”窗格中，选择“ 已安装的模板”并展开Visual C＃节点。在Visual C＃下，选择Web。在项目模板列表中，选择ASP.NET Web应用程序。将项目命名为“ProductsApp”，然后单击“ 确定”。

在“ 新建ASP.NET项目”对话框中，选择“ 空”模板。在“添加文件夹和核心参考”下，查看Web API。单击确定。

注意

您还可以使用“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请求消息中设置Accept头来指示所需的格式。

我们先来创建一个代表产品的简单模型。

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

将类命名为“产品”。将以下属性添加到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类而不是Controller类。

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

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

在“ 添加控制器”对话框中，命名控制器“ProductsController”。单击添加。

脚手架在Controllers文件夹中创建一个名为ProductsController.cs的文件。

注意

您不需要将控制器放入名为Controllers的文件夹中。文件夹名称只是组织源文件的一种方便的方法。

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

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 = , Name = "Tomato Soup", Category = "Groceries", Price =  },

            new Product { Id = , Name = "Yo-yo", Category = "Toys", Price = 3.75M },

            new Product { Id = , 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：

控制器方法	URI
GetAllProducts	/ API /产品
GetProduct	/ api / products / id

对于该GetProduct方法，URI中的id是占位符。例如，要获得ID为5的产品，URI为api/products/5。4

有关Web API如何将HTTP请求路由到控制器方法的更多信息，请参阅ASP.NET Web API中的路由。

使用Javascript和jQuery调用Web API

在本节中，我们将添加一个使用AJAX调用Web API的HTML页面。我们将使用jQuery进行AJAX调用，并且还可以使用结果更新页面。

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

在添加新项目对话框中，选择Visual C＃下的Web节点，然后选择HTML页面项目。将页面命名为“index.html”。

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

<!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/下载，ASP.NET“Web API”项目模板也包含jQuery。

获取产品列表

要获取产品列表，请发送HTTP GET请求到“/ api / products”。

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 / products / id ”，其中id是产品ID。

function find() {

    var id = $('#prodId').val();

    $.getJSON(apiUrl + '/' + id)

        .done(function (data) {

            $('#product').text(formatItem(data));

        })

        .fail(function (jqXHR, textStatus, err) {

            $('#product').text('Error: ' + err);

        });

}

我们仍然呼吁getJSON发送AJAX请求，但是这次我们把ID放在请求URI中。此请求的响应是单个产品的JSON表示。

运行应用程序

按F5开始调试应用程序。网页应如下所示：

要通过ID获取产品，请输入ID并单击搜索：

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

使用F12查看HTTP请求和响应

当您使用HTTP服务时，查看HTTP请求和请求消息非常有用。您可以使用Internet Explorer 9中的F12开发人员工具完成此操作。从Internet Explorer 9中，按F12打开工具。单击网络选项卡，然后按开始捕获。现在回到网页，按F5重新加载网页。Internet Explorer将捕获浏览器和Web服务器之间的HTTP流量。摘要视图显示页面的所有网络流量：1

找到相对URI“api / products /”的条目。选择此条目，然后单击转到详细视图。在详细视图中，有选项卡来查看请求和响应标头和主体。例如，如果您单击请求标题选项卡，您可以看到客户端在Accept标头中请求“application / json”。

如果您单击“响应体”选项卡，可以看到产品列表如何序列化为JSON。其他浏览器具有相似的功能。另一个有用的工具是Fiddler，一个Web调试代理。您可以使用Fiddler查看您的HTTP流量，还可以撰写HTTP请求，从而可以完全控制请求中的HTTP头。

Web API 2 入门——Web API 2（C＃）入门（谷歌翻译）的更多相关文章

Web API 2 入门——使用ASP.NET Web API和Angular.js构建单页应用程序（SPA）（谷歌翻译）
在这篇文章中概观演习概要由网络营下载网络营训练包在传统的Web应用程序中,客户机(浏览器)通过请求页面启动与服务器的通信.然后,服务器处理请求,并将页面的HTML发送给客户端.在与页面的后 ...
Web API 2 入门——创建ASP.NET Web API的帮助页面（谷歌翻译）
在这篇文章中创建API帮助页面将帮助页面添加到现有项目添加API文档在敞篷下下一步作者:Mike Wasson 创建Web API时,创建帮助页面通常很有用,以便其他开发人员知道如何调用A ...
Request Entity Too Large for Self Hosted ASP.Net Web API在Selfhost的api后台怎么解决Request Entity Too Large问题
Request Entity Too Large for Self Hosted ASP.Net Web API在Selfhost的api后台怎么解决Request Entity Too Large问 ...
ASP.NET Web API与Rest web api(一)
HTTP is not just for serving up web pages. It is also a powerful platform for building APIs that exp ...
ASP.NET Web API与Rest web api（一）
本文档内容大部分来源于:http://www.cnblogs.com/madyina/p/3381256.html HTTP is not just for serving up web pages. ...
[Web API] 如何让 Web API 统一回传格式以及例外处理[转]
[Web API] 如何让 Web API 统一回传格式以及例外处理前言当我们在开发 Web API 时,一般的情况下每个 API 回传的数据型态或格式都不尽相同,如果你的项目从头到尾都是由你一个 ...
[Web API] 如何让 Web API 统一回传格式以及例外处理
[Web API] 如何让 Web API 统一回传格式以及例外处理前言当我们在开发 Web API 时,一般的情况下每个 API 回传的数据型态或格式都不尽相同,如果你的项目从头到尾都是由你一个 ...
jboss7 Java API for RESTful Web Services (JAX-RS) 官方文档
原文:https://docs.jboss.org/author/display/AS7/Java+API+for+RESTful+Web+Services+(JAX-RS) Content Tuto ...
Web服务器Raspkate的RESTful API
基于轻量型Web服务器Raspkate的RESTful API的实现在上一篇文章中,我们已经了解了Raspkate这一轻量型Web服务器,今天,我们再一起了解下如何基于Raspkate实现简单的RE ...

随机推荐

用js实现匹配文本中的电话号、固定电话号
思路: 1.用正则取出所有数字串说起来容易,做起来难,开始只是简单的/D+/,后边发现这样做会将固定电话分成两段数字串,后经百度找到解决办法 /[^0-9/-]/ 意思是非数字不包括-作为分割 2. ...
查看SqlServer某张表的物理空间占用情况
以下语句可以查看表的物理空间使用情况包括 [ROWS] 内容的行数.. [reserved] 保留的磁盘大小.. [data] 数据占用的磁盘大小.. [index_size] 索引占用的磁盘大小. ...
【Qt开发】更改应用程序图标和任务栏图标
说明实际开发过程中,生成的应用文件不会用默认的图标,同时程序启动后任务栏的图标也需要修改,还有窗口的图标,这样显得程序不那么low.更改程序的图标有多种方式,基于Qt Creator或vs开发的方式 ...
Win32 DPAPI加密编程
DPAPI函数是CryptoAPI中少有的简单易用的加密函数,调用过程简单,其调用接口几乎不涉及密码学概念.Win32 DPAPI有4个函数,它们分别是CryptProtectData.CryptUn ...
Maven 配置Tomcat
1.Tomcat conf 下的tomcat-users.xml 增加 <role rolename="manager"/> <role rolename=&qu ...
access 2010,语文
access 2010*(报表) 使用报表创建:打开需要创建图形的报表----创建----报表----完成. 使用报表向导创建:创建----报表向导----选择表/查询----选择字段----设置分布 ...
Java实现在线预览–openOffice实现
实现逻辑有两种: 一.利用jodconverter(基于OpenOffice服务)将文件(.doc..docx..xls..ppt)转化为html格式. 二.利用jodconverter(基于Open ...
java 的底层通信--Socket
以前一直不太重视java 基础的整理,感觉在实际开发中好像java 基础用处不大,感觉不理解一些底层的东西对开发工作影响也不大.不过,后来我发现,很多东西都是相互联系的,如果底层的东西你不理解,后面的 ...
Java 基础（1）—— 开始前的准备
虽然学习 Java 已有一年多,但是从来没有仔细总结或者复习过.于是准备借用博客来进行一波学习记录.从头开始,学习 Java. Java 介绍生产公司:Sun Microsystems 公司(200 ...
Window 10 安装 MySQL
1.下载点击官网下载路径下载压缩包点击第一个按钮后出现如下界面下载后解压缩,我这里是放在C:\web\目录下 2.创建配置文件注意:my.ini文件是自己创建的配置文件文件内容如下: [my ...

Web API 2 入门——Web API 2（C＃）入门（谷歌翻译）