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,然后单击:文件 -> 新建 -> 项目 菜单选项。
一个新的项目对话框打开。如下图所示 -
第2步 - 在左侧窗格中,选择:模板 -> Visual C# -> Web 。
第3步 - 在中间窗格中,选择“ASP.NET Web应用程序”,在名称字段中输入项目名称:WebAPIDemo ,然后单击确定 以继续。将看到以下对话框,要求您为ASP.NET项目设置初始内容。如下图所示 -
第4步 - 为了简单起见,请选择: 空 选项,并在“为以下项添加文件夹和核心引用” 部分中选中Web API 复选框,然后单击 确定 。
第5步 - 它将创建一个基本的MVC项目与最小的预定义的内容。
项目由Visual Studio创建后,在“解决方案资源管理器”窗口中看到许多文件和文件夹。
第6步 - 现在需要添加一个模型。右键单击解决方案资源管理器 中的Models 文件夹,然后选择:添加 -> 类。将看到添加新项目对话框。
第7步 - 选择中间平台的类,并在名称字段中输入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步 - 添加控制器。右键单击解决方案资源管理器 中的Controllers 文件夹,然后选择:添加 -> 控制器 。它将显示“添加基架”对话框 -
第10步 - 选择:Web API 2控制器 - 空 选项。该模板将为控制器创建一个具有默认操作的Index方法。
第11步 - 点击“添加”按钮,添加控制器对话框将出现。
第12步 - 将名称设置为:EmployeesController,然后单击“添加” 按钮。
在Controllers文件夹中看到一个新的 C# 文件 - EmployeeController.cs,该文件夹在Visual Studio中打开,并进行一些默认操作。如下代码 -
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using WebAPIDemo.Models;
namespace WebAPIDemo.Controllers
{
public class EmployeesController : ApiController
{
Employee[] employees = new Employee[]{
new Employee { ID = 1, Name = "Maxsu", 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 = "AvgWong", 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:http://localhost:58150/api/employees/ ,然后按“Enter”。将看到以下输出 -
第14步 - 再次访问URL:http://localhost:58150/api/employees/1 ,将看到以下输出 -
¥ 我要打赏
纠错/补充
收藏
加QQ群啦,易百教程官方技术学习群
注意:建议每个人选自己的技术方向加群,同一个QQ最多限加 3 个群。