ASP.NET Web API2 Introduction

最新推荐文章于 2025-01-25 18:32:31 发布

feng1456

最新推荐文章于 2025-01-25 18:32:31 发布

阅读量977

点赞数

CC 4.0 BY-SA版权

分类专栏： ASP.NET MVC 文章标签： web api asp.net jquery ajax soa

本文链接：https://blog.youkuaiyun.com/afandaafandaafanda/article/details/42776809

ASP.NET MVC 专栏收录该内容

36 篇文章

订阅专栏

本文介绍了轻量级的ASP.NET WebAPI框架的诞生背景、核心概念及其在非Web应用领域的实践案例。通过新建实体类、创建ApiController控制器以及实现统一的HTTP访问方式，展示了如何利用WebAPI进行服务的统一调用和资源化处理。同时，通过Ajax请求和jQuery的特性，演示了如何高效地与WebAPI进行交互并操作DOM，突显了其简洁性和灵活性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

应用程序通信一直是架构设计方面的终点，微软从DCOM到.NET Remoting，再到WCF，一致致力于提供统一，规范的通信编程模式。WCF作为重量级的通信框架，一时间成为了SOA和WebService的代名词。在非Web应用领域，WCF的地位无可撼动，SOA包括的内容很大，单纯一个WCF就代表了SOA的说法站不住脚，即使是在微软的技术体系内。进入了web时代，移动大行其道。WCF的劣势慢慢显现出来了。WCF虽然应用起来相对灵活，但是跟随微软技术潮流的开发者不难发现，ASP.NET MVC5开始支持mobile的应用，加上HTML5，Jquery，ExtJs对mobile的支持，多终端的模式下，WCF的客户端需要个性化定制开发，java的客户端如果要使用WCF的服务相对来说还是比较繁琐的。那么安卓客户端，IOS客户端呢？将来可能还有更多的终端需要支持，比如智能硬件和可穿戴设备呢？

无论是哪种通信方式，底层都使基于Http的模式，那么能不能开发一种全新的通信方式，让所有的服务消费者都能够通过统一的方式来使用服务呢？ASP.NET WebAPI就是基于这样的想法诞生的。通常认为ASP.NET WebAPI是轻量级的WCF。采用Http的GET/POST/DELETE等方式来访问，认为所有可用的服务都使资源，而不关心到底是什么类型的语言开发的，这就是REST API架构模式。

1.新建项目

新增实体类Products

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

新增控制器（ApiController）

Note:ApiController和MVC的controller非常像，不同之处在于继承ApiController。

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);
        }
}

新增一个页面

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title>Product App</title>
    <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>
</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>
</body>
</html>