猿教程 Logo

创建包含CRUD操作的Web API接口-第一部分

在这里,我们将创建一个新的Web API项目,它将使用实体框架实现Get,POST、PUT和DELETE方法来实现CRUD操作。

首先,在Visual Studio 2013 for Web express edition中创建一个新的Web API项目。

打开Visual Studio 2013 for Web点击文件菜单- >新建项目。这将打开新建项目弹窗如下所示。


在弹出的新将项目弹窗中,选择Visual C#下的Web模板。输入项目名称WebApiDemo并选择你想要创建的项目的位置。单击OK继续。这将打开一个弹窗选择一个项目模板。选择Web API项目如下所示。


在这里,在我们的演示项目中我们不会使用任何身份验证。所以,点击Change Authentication按钮来打开验证弹窗,并选择No Authentication单选按钮,然后单击OK,如下所示。


现在,在新建项目弹窗单击OK, 创建项目如下所示。


正如你所看到的,创建了一个新的WebApiDemo项目和所有必要的文件。

它也默认添加了ValuesController控制器,可以删除默认的ValuesController,因为我们将添加新的Web API控制器。

在这里,我们要使用实体框架DB-First方法访问数据库现有的School数据库。

所以,让我们使用DB First方法加入School数据库的EF 数据模型。

正如你所看到的,创建了一个新的WebApiDemo项目和所有必要的文件。它也默认添加了ValuesController控制器,可以删除默认的ValuesController,因为我们将添加新的Web API控制器。

在这里,我们要使用实体框架DB-First方法访问数据库现有的School数据库。所以,让我们使用DB First方法加入School数据库的EF 数据模型。


添加Entity Framework数据Model

使用DB-First方法加入Entity Framework数据模型,右键单击您的项目- >点击New Item..这将打开添加新项弹窗如下所示。


在左窗格中选择"Data"并在中间窗口“ADO.NET Entity Data Model ”,输入一个数据模型的名称,单击Add。这将打开实体数据模型向导,使用它可以为现有的School数据库生成实体数据模型。本教程的主题是讲解Web API,对于Entity Framework方面的知识,可以点击这里了解更多关于EntityFramework的教程。

完成所有实体数据模型向导的步骤后,EntityFramework将生成以下数据模型。


EntityFramework还生成了实体和上下文类,如下所示。


现在,我们已经准备好了在我们的Web API项目中使用实体框架实现CRUD的操作。现在,让我们在我们的项目中添加一个Web API控制器。


添加Web API 控制器

在MVC项目中添加一个Web API控制器,右键单击Controllers文件夹或另一个你想添加一个Web API控制器的文件夹- >选择add - >选择Controller。这将打开Add Scaffold弹窗如下所示。


在Add Scaffold 弹窗,在左窗格中选择Web API,在中间窗格中选择Web API 2 Controller - Empty,单击Add。(我们选择空模板作为添加Action方法。)

这将打开Add Controller弹窗,你需要输入控制器的名称。输入“StudentController”作为控制器名称并单击添加如下所示。


这将添加继承自ApiController的空的StudentController类如下所示。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
namespace MyMVCApp.Controllers
{
    public class StudentController : ApiController
    {
    
    }
}

在随后的教程中,我们将在该控制器中实现GET、POST、PUT和DELETE操作方法。


添加Model

我们将使用实体框架(EF)访问底层数据库。如您所见,EF创建了自己的实体类。理想情况下,我们不应该从Web API返回EF实体对象。建议从Web API返回DTO(数据传输对象)。由于我们创建的Web API项目带有MVC功能,我们也可以使用MVC模型类,MVC模型类可以同时被MVC和Web API使用。

在这个Web API项目中,我们将Student, Address 和 Standard 。所以,在Models创建StudentViewModel AddressViewModel和StandardViewModel模型如下所示。


以下是模型类。

public class StudentViewModel
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
        
    public AddressViewModel Address { get; set; }
    public StandardViewModel Standard { get; set; }
}
public class StandardViewModel
{
    public int StandardId { get; set; }
    public string Name { get; set; }
    public ICollection<StudentViewModel> Students { get; set; }
} 
public class AddressViewModel
{
    public int StudentId { get; set; }
    public string Address1 { get; set; }
    public string Address2 { get; set; }
    public string City { get; set; }
    public string State { get; set; }
}

注意:ViewModel类或DTO类只是为了从Web API控制器数据传输到客户端。你可以根据你的选择命名。

现在,让我们在下一节实现Get方法来处理各种HTTP Get请求。


版权声明:本站所有教程均为本站原创或翻译,转载请注明出处,请尊重他人劳动果实。请记住本站地址:www.yuanjiaocheng.net (猿教程) 作者:卿文刚
本文标题: C#环境
本文地址:http://www.yuanjiaocheng.net/webapi/create-crud-api-1.html