专栏首页葡萄城控件技术团队ASP.NET 5系列教程 (六): 在 MVC6 中创建 Web API

ASP.NET 5系列教程 (六): 在 MVC6 中创建 Web API

ASP.NET 5.0 的主要目标之一是统一MVC 和 Web API 框架应用。

接下来几篇文章中您会了解以下内容:

  • ASP.NET MVC 6 中创建简单的web API。
  • 如何从空的项目模板中启动,及添加控件到应用中。
  • 如何配置 ASP.NET 5.0 管道。
  • 在 IIS 外对立部署应用。

本文的目的是从空的项目开始,逐步讲解如何创建应用。当然,您也可以从“Starter Web” 模板开始,它默认包含了MVC 6、权限、记录等其他模块,同时也内置了有效的控制器和视图在其中。

创建空的 ASP.NET 5 项目

打开 Visual Studio 2015。点击 File 菜单,选择 New > Project。

New Project 对话框中,点击 Templates > Visual C# > Web,选择 ASP.NET Web Application 项目模板。命名为 "TodoApi",点击 OK。

New ASP.NET Project 对话框中,选择 "ASP.NET 5.0 Empty" 模板。

下面的效果图展示了工程结构:

工程包含以下文件:

  • global.json 包含了解决方案级别的设置,允许工程到工程之间的引用。
  • project.json 包含了工程级别的设置。
  • Project_Readme.html  为 readme 文件。
  • Startup.cs 包含启动和配置代码。

Startup.cs 文件中的Startup 类,配置了 ASP.NET 需求管道。当你使用空的项目模板,Startup 类不会有任何实质性的代码加入到管道中:

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        // Nothing here!
    }
}

现在,你可以运行应用了,但当前的应用没有任何功能。接下来我们会模拟"Starter Web" 项目模板来添加功能,例如 MVC 6、Entity Framework、身份验证、记录等功能。

添加欢迎界面

打开 project.json 文件。该文件包含了工程设置内容。dependencies 部分用于标注需要的NuGet 包和类库。添加 Microsoft.AspNet.Diagnostics 包到列表中:

"dependencies": {
    "Microsoft.AspNet.Server.IIS": "1.0.0-beta1",
    // Add this: 
    "Microsoft.AspNet.Diagnostics": "1.0.0-beta1"
},

输入时, Visual Studio 会提供智能提示:

接下来,打开 Startup.cs 文件,添加以下代码:

using System;
using Microsoft.AspNet.Builder;


namespace TodoApi
{
    public class Startup
    {
        public void Configure(IApplicationBuilder app)
        {
            // New code
            app.UseWelcomePage();
        }
    }
}

点击  F5 运行,Visual Studio 启动浏览器,打开了 http://localhost:port/,端口号是一个Visual Studio随机分配的数字。运行效果如下:

欢迎界面是检验运行效果的快速入口,无需编写代码。

创建 Web API

在本章节中,您将创建一个 ToDo 事项管理列表功能API。首先,我们需要添加 ASP.NET MVC 6 到应用中。

添加 MVC 6 到 project.json 文件的依赖列表中:

"dependencies": {
    "Microsoft.AspNet.Server.IIS": "1.0.0-beta1",
    "Microsoft.AspNet.Diagnostics": "1.0.0-beta1",
    // New:
    "Microsoft.AspNet.Mvc": "6.0.0-beta1"
},

接下来,添加 MVC 需求管道到 Startup.cs 文件中,

  • 使用 using 声明Microsoft.Framework.DependencyInjection。
  • 添加以下方法到 Startup 类中。
public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
}
  • 下面这段代码添加了 MVC 6 需要的所有依赖项,会自动在启动时调用ConfigureServices
    • 在配置方法中添加以下代码,UseMvc 方法用于添加 MVC 6 到管道。
 public void Configure(IApplicationBuilder app)
 {
     // New:
     app.UseMvc();
 }

以下是完整的 Startup 类代码:

 using System;
 using Microsoft.AspNet.Builder;
 using Microsoft.AspNet.Http;
 // New using:
 using Microsoft.Framework.DependencyInjection;
 namespace TodoApi
 {
 public class Startup
     {
         // Add this method:
 public void ConfigureServices(IServiceCollection services)
         {
             services.AddMvc();
         }
 public void Configure(IApplicationBuilder app)
         {
             // New:
             app.UseMvc();
             app.UseWelcomePage();
         }
     }
 }

添加 Model model 代表应用的数据域。在本示例中,model 中存储 ToDo 项。 添加以下类到项目中:

 using System.ComponentModel.DataAnnotations;
 namespace TodoApi.Models
 {
 public class TodoItem
     {
 public int Id { get; set; }
         [Required]
 public string Title { get; set; }
 public bool IsDone { get; set; }
     }
 }

为了保持项目的整洁,我创建了 Models 文件夹用于存放 Model 类,当然这不是必要的操作。 添加 Controller 添加 controller 类用于处理 HTTP 请求。添加以下类到项目中:

 using Microsoft.AspNet.Mvc;
 using System.Collections.Generic;
 using System.Linq;
 using TodoApi.Models;
 namespace TodoApi.Controllers
 {
     [Route("api/[controller]")]
 public class TodoController : Controller
     {
 static readonly List<TodoItem> _items = new List<TodoItem>()
         {
 new TodoItem { Id = 1, Title = "First Item" }
         };
         [HttpGet]
 public IEnumerable<TodoItem> GetAll()
         {
 return _items;
         }
         [HttpGet("{id:int}", Name = "GetByIdRoute")]
 public IActionResult GetById (int id)
         {
             var item = _items.FirstOrDefault(x => x.Id == id);
 if (item == null)
             {
 return HttpNotFound();
             }
 return new ObjectResult(item);
         }
         [HttpPost]
 public void CreateTodoItem([FromBody] TodoItem item)
         {
 if (!ModelState.IsValid)
             {
                 Context.Response.StatusCode = 400;
             }
 else
             {
                 item.Id = 1+ _items.Max(x => (int?)x.Id) ?? 0;
                 _items.Add(item);
 string url = Url.RouteUrl("GetByIdRoute", new { id = item.Id }, 
                     Request.Scheme, Request.Host.ToUriComponent());
                 Context.Response.StatusCode = 201;
                 Context.Response.Headers["Location"] = url;
             }
         }
         [HttpDelete("{id}")]
 public IActionResult DeleteItem(int id)
         {
             var item = _items.FirstOrDefault(x => x.Id == id);
 if (item == null)
             {
 return HttpNotFound();
             }
             _items.Remove(item);
 return new HttpStatusCodeResult(204); // 201 No Content
         }
     }
 }

同样,我创建了 Controllers 文件夹用于存储 controller。 在后续的章节中我们将进一步阐述关于 Controller 的代码。以下是 controller 实现的一些基础功能:

例如,下面是获取 ToDo 项目的 HTTP 请求的:

 GET http://localhost:5000/api/todo HTTP/1.1
 User-Agent: Fiddler
 Host: localhost:5000
 下面是 response 流:
 HTTP/1.1 200 OK
 Content-Type: application/json;charset=utf-8
 Server: Microsoft-HTTPAPI/2.0
 Date: Thu, 30 Oct 2014 22:40:31 GMT
 Content-Length: 46
 [{"Id":1,"Title":"First Item","IsDone":false}]

后续章节中我们将阐述以下内容:

  • 如何配置 ASP.NET 5.0 管道。
  • 在 IIS 外对立部署应用。

有了本节如何在 MVC6 中创建 Web API的讲解,相信大家会对ASP.NE的理解又加深了一步。

系列文章目录:

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 分享自制的C#和VB Code互转工具

    作为.NET程序员,往往习惯使用一种语言(据我观察,2006年后的程序员习惯用C#,之前的喜欢VB)。而对于另一种语言虽然能读懂但是写起来总是比较费事。尤其面对...

    葡萄城控件
  • 深入浅出OOP(四): 多态和继承(抽象类)

    在本文中,我们讨论OOP中的热点之一:抽象类。抽象类在各个编程语言中概念是一致的,但是C#稍微有些不一样。本文中我们会通过代码来实现抽象类,并一一进行解析。 A...

    葡萄城控件
  • 深入浅出OOP(五): C#访问修饰符(Public/Private/Protected/Internal/Sealed/Constants)

    访问修饰符(或者叫访问控制符)是面向对象语言的特性之一,用于对类、类成员函数、类成员变量进行访问控制。同时,访问控制符也是语法保留关键字,用于封装组件。 Pub...

    葡萄城控件
  • EF Core下利用Mysql进行数据存储在并发访问下的数据同步问题

    小故事 在开始讲这篇文章之前,我们来说一个小故事,纯素虚构(真实的存钱逻辑并非如此) 小刘发工资后,赶忙拿着现金去银行,准备把钱存起来,而与此同时,小刘的老婆刘...

    码农阿宇
  • .NET Core中使用RabbitMQ正确方式

    然后是.NET Client链接:http://www.rabbitmq.com/dotnet.html

    李国宝
  • Storm(三)Java编写第一个本地模式demo

    本地模式 在本地模式下,Storm拓扑结构运行在本地计算机的单一JVM进程上。这个模式用于开发、测试以及调试,因为这是观察所有组件如何协同工作的最简单方法。在...

    stys35
  • 初学java之事件响应(结合接口来设置在同一个界面上!)

    1 package wahaha; 2 3 public class test_1 { 4 public static void main( ...

    Gxjun
  • 复习:GoF的23种设计模式之Template Method模式(行为型)

    就如我们打开CSDN的每一个页面,都有一个已备案提醒的尾标,每一个页面都有,那么是不是每个页面都去添加相同的代码呢?

    营琪
  • AsyncTask源码深入解析

    最近想写一篇关于源码解析的文章,发现AsyncTask代码量不多,可里面的东西却是很值得学习的,所以故那这来“开刀”

    HelloJack
  • SpringBoot 中 mongo多数据源配置新姿势

    SpringBoot对常用的数据库支持外,对NoSQL 数据库也进行了封装自动化。这一篇主要讲springboot与mongo多数据源相关的配置

    码农小胖哥

扫码关注云+社区

领取腾讯云代金券