学习篇一：Web API

叁歲伎倆 2021-06-24 16:11 427阅读 0赞

## 第一章：初识 ##

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中强制使用Https][Web Api_Https]

#### 1.1 入门实例 ####

###### 1.1.1 创建MVC项目，HelloWebAPI ######

![2789632-15dc086c9d9c66bd.png][]

![2789632-3530a9dcaee13370.png][]

###### 1.1.2 添加一个Model,product.cs ######

using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    
    namespace HelloWebAPI.Models
    {
        public class Product
        {
            public int Id { get; set; }
            public string Name { get; set; }
            public string Category { get; set; }
            public decimal Price { get; set; }
        }
    }

###### 1.1.3 添加一个controller ######

![2789632-1a9348086cce459d.png][]

using HelloWebAPI.Models;
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Net;
    using System.Web;
    using System.Web.Http;
    using System.Web.Mvc;
    
    namespace HelloWebAPI.Controllers
    {
        public class ProductsController : ApiController
        {
            //
            // GET: /Products/
    
            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 Product GetProductById(int id)
            {
                var product = products.FirstOrDefault((p) => p.Id == id);
                if (product == null)
                {
                    throw new HttpResponseException(HttpStatusCode.NotFound);
                }
                return product;
            }
            public IEnumerable<Product> GetProductsByCategory(string category)
            {
                return products.Where(
                    (p) => string.Equals(p.Category, category,
                        StringComparison.OrdinalIgnoreCase));
            }
    
        }
    }

![2789632-58d90d5abb291941.png][]

#### 1.2 知识点整理 ####

###### 1.2.1 如何修改请求方式 ######

我们可以看到在Action 中没有使用\[HttpGet\]、\[HttpPost\] 等修饰,那究竟它是如何运作的呢？  
  Action 皆以HTTP 动词开头Get、Post、Put、Delete ,这个也是刚好符合 webapi的约定的。  
  你调用什么类型的方法 ,例如 post 方法,那么他就去 你的所有的 action 里面 去找 以 post 开头的方法 ,名字可以随便叫,例如 postToDataBase 等等,只要开头匹配 就可以了  
例如：在上面的例子中：

public IEnumerable<Product> GetAllProducts()
            {
                return products;
            }

当改成PostAllProducts时，则以Post的请求方式。

![2789632-a467b8c854e05311.gif][]

方法名虽然带Get，Post,但是在请求的的时候并不用加上。  
有几种标准的请求，如get,post,put,delete等，它们分别对应的几个操作，下面讲一下：

*  GET：生到数据列表（默认），或者得到一条实体数据
 *  POST：添加服务端添加一条记录，记录实体为Form对象
 *  PUT：添加或修改服务端的一条记录，记录实体的Form对象，记录主键以GET方式进行传输
 *  DELETE：删除 服务端的一条记录

###### 1.2.2 如何传递参数？ ######

![2789632-0d6b91a74c3796ee.png][]

在方法里直接添加参数，然后运行那程序，可以看到：

![2789632-c71f70dbaee7cf43.png][]

![2789632-159d070a9432af2c.png][]

当然这里的1，2并没有实际意义。再看看传递一个实体看看：

![2789632-5097dc63d978639e.png][]

![2789632-62fb84d187b4ae79.png][]

原来的文件：（由于里面存在一些不必要的东西，试试删除一些，简化一点）

![2789632-c4237698e38fcf30.png][]

修改后的文件结构：（不喜欢启动时什么都没有，添加了一个index.html,修改下路由配置）

![2789632-6aa161c68c53bc5d.png][]

启动：

![2789632-76f3e27162d0fce5.png][]

数据接口暂时告一段落，然后接下来学习EF 的code first的学习……

[Web Api_Https]: https://link.jianshu.com?t=http://www.aizhengli.com/aspnet-web-api-rest/27/aspnet-web-api-rest-security.html
[2789632-15dc086c9d9c66bd.png]: /images/20210615/8411c9bb20614788a197c1dd8cdaf042.png
[2789632-3530a9dcaee13370.png]: /images/20210615/979947d490184d71b1c94b2f1a1f087e.png
[2789632-1a9348086cce459d.png]: /images/20210615/7a72b500570048b5b388499d77a4c4f3.png
[2789632-58d90d5abb291941.png]: /images/20210615/9ebbf55526534625b309657f17555705.png
[2789632-a467b8c854e05311.gif]: /images/20210615/27c60b84d7374536b3146615763eb5ff.png
[2789632-0d6b91a74c3796ee.png]: /images/20210615/4374fcd1c6c6492299b0b672922d6aef.png
[2789632-c71f70dbaee7cf43.png]: /images/20210615/262855eed5284b9b8657d688af6a4eb7.png
[2789632-159d070a9432af2c.png]: /images/20210615/451f6faffd2047438e2fa7b3b02b3e18.png
[2789632-5097dc63d978639e.png]: /images/20210615/e6753a6f6be345fb8843135502528dbe.png
[2789632-62fb84d187b4ae79.png]: /images/20210615/11743134212945f99c52f3213030d43a.png
[2789632-c4237698e38fcf30.png]: /images/20210615/9c50ae8546d14122acf9f05b0580cce4.png
[2789632-6aa161c68c53bc5d.png]: /images/20210615/bff385ebba7a47dc876fbe97d5359591.png
[2789632-76f3e27162d0fce5.png]: /images/20210615/1d62716addb14847aa77b3e864277eb9.png