📜  ASP.NET MVC-Web API

📅  最后修改于: 2020-11-21 05:21:18             🧑  作者: Mango


ASP.NET Web API是一个框架,可以轻松地构建可访问范围广泛的客户端(包括浏览器和移动设备)的HTTP服务。 ASP.NET Web API是在.NET Framework上构建RESTful应用程序的理想平台。

在Web上构建API时,可以通过多种方法在Web上构建API。其中包括HTTP / RPC,这意味着在远程过程调用中使用HTTP在整个Web中调用诸如方法之类的东西。

这些动词本身包含在API中,例如“获取客户”,“插入发票”,“删除客户”,并且这些端点中的每个端点最终都是一个单独的URI。

通过创建一个新的ASP.NET Web应用程序,让我们看一个简单的Web API示例。

步骤1-打开Visual Studio,然后单击文件→新建→项目菜单选项。

将打开一个新的“项目”对话框。

Visual Studio单击文件

步骤2-从左窗格中,选择模板→Visual C#→Web。

步骤3-在中间窗格中,选择ASP.NET Web应用程序

在名称字段中输入项目名称WebAPIDemo,然后单击确定以继续。您将看到以下对话框,要求您设置ASP.NET项目的初始内容。

WebAPI演示

步骤4-为简单起见,选择Empty选项,然后在“添加文件夹和核心引用的对象”部分中选中Web API复选框,然后单击确定。

步骤5-将创建具有最少预定义内容的基本MVC项目。

由Visual Studio创建项目后,您将在“解决方案资源管理器”窗口中看到许多文件和文件夹。

步骤6-现在我们需要添加一个模型。右键单击解决方案资源管理器中的“模型”文件夹,然后选择“添加”→“类”。

添加模型

现在,您将看到“添加新项”对话框。

添加项目对话框

步骤7-在中间窗格中选择Class,然后在名称字段中输入Employee.cs。

步骤8-使用以下代码将一些属性添加到Employee类。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

namespace WebAPIDemo.Models {
   public class Employee{
      public int ID { get; set; }
      public string Name { get; set; }
      public DateTime JoiningDate { get; set; }
      public int Age { get; set; }
   }
}

步骤9-让我们添加控制器。右键单击解决方案资源管理器中的controller文件夹,然后选择Add→Controller。

它将显示“添加支架”对话框。

选择添加控制器

步骤10-选择Web API 2 Controller-空选项。该模板将使用控制器的默认操作创建一个Index方法。

步骤11-单击“添加”按钮,将出现“添加控制器”对话框。

添加按钮控制器

步骤12-将名称设置为EmployeesController,然后单击“添加”按钮。

您将在Controllers文件夹中看到一个新的C#文件’EmployeeController.cs’,该文件可以在Visual Studio中使用一些默认操作进行编辑。

using System;
using System.Collections.Generic;
using System.Linq;

using System.Web.Http;
using WebAPIDemo.Models;

namespace WebAPIDemo.Controllers{
   public class EmployeesController : ApiController{
      Employee[] employees = new Employee[]{
         new Employee { ID = 1, Name = "Mark", JoiningDate =
            DateTime.Parse(DateTime.Today.ToString()), Age = 30 },
         new Employee { ID = 2, Name = "Allan", JoiningDate =
            DateTime.Parse(DateTime.Today.ToString()), Age = 35 },
         new Employee { ID = 3, Name = "Johny", JoiningDate =
            DateTime.Parse(DateTime.Today.ToString()), Age = 21 }
      };
        
      public IEnumerable GetAllEmployees(){
         return employees;
      }
        
      public IHttpActionResult GetEmployee(int id){
         var employee = employees.FirstOrDefault((p) => p.ID == id);
         if (employee == null){
            return NotFound();
         }
         return Ok(employee);
      }
   }
}

步骤13-运行此应用程序,并在URL末尾指定/ api / employees /,然后按“ Enter”。您将看到以下输出。

指定API员工

步骤14-让我们指定以下URL http:// localhost:63457 / api / employees / 1 ,您将看到以下输出。

Localhost API员工