ASP.NET 5系列教程 (六): 在 MVC6 中創(chuàng)建 Web API

ASP.NET 5.0 的主要目標(biāo)之一是統(tǒng)一MVC 和 Web API 框架應(yīng)用。

接下來幾篇文章中您會(huì)了解以下內(nèi)容：

• ASP.NET MVC 6 中創(chuàng)建簡(jiǎn)單的web API。

• 如何從空的項(xiàng)目模板中啟動(dòng)，及添加控件到應(yīng)用中。

• 如何配置 ASP.NET 5.0 管道。

• 在 IIS 外對(duì)立部署應(yīng)用。

本文的目的是從空的項(xiàng)目開始，逐步講解如何創(chuàng)建應(yīng)用。當(dāng)然，您也可以從“Starter Web” 模板開始，它默認(rèn)包含了MVC 6、權(quán)限、記錄等其他模塊，同時(shí)也內(nèi)置了有效的控制器和視圖在其中。

創(chuàng)建空的 ASP.NET 5 項(xiàng)目

打開 Visual Studio 2015。點(diǎn)擊 File 菜單，選擇 New > Project。

在 New Project 對(duì)話框中，點(diǎn)擊 Templates > Visual C# > Web，選擇 ASP.NET Web Application 項(xiàng)目模板。命名為 "TodoApi"，點(diǎn)擊 OK。

cdn_id=2015-01-19-002">

在 New ASP.NET Project 對(duì)話框中，選擇 "ASP.NET 5.0 Empty" 模板。

下面的效果圖展示了工程結(jié)構(gòu)：

工程包含以下文件：

• global.json 包含了解決方案級(jí)別的設(shè)置，允許工程到工程之間的引用。

• project.json 包含了工程級(jí)別的設(shè)置。

• Project_Readme.html  為 readme 文件。

• Startup.cs 包含啟動(dòng)和配置代碼。

Startup.cs 文件中的Startup 類，配置了 ASP.NET 需求管道。當(dāng)你使用空的項(xiàng)目模板，Startup 類不會(huì)有任何實(shí)質(zhì)性的代碼加入到管道中：

public class Startup

{

    public void Configure(IApplicationBuilder app)

    {

        // Nothing here!

    }

}

現(xiàn)在，你可以運(yùn)行應(yīng)用了，但當(dāng)前的應(yīng)用沒有任何功能。接下來我們會(huì)模擬"Starter Web" 項(xiàng)目模板來添加功能，例如 MVC 6、Entity Framework、身份驗(yàn)證、記錄等功能。

添加歡迎界面

打開 project.json 文件。該文件包含了工程設(shè)置內(nèi)容。dependencies 部分用于標(biāo)注需要的NuGet 包和類庫(kù)。添加 Microsoft.AspNet.Diagnostics 包到列表中：

"dependencies": {

    "Microsoft.AspNet.Server.IIS": "1.0.0-beta1",

    // Add this:

    "Microsoft.AspNet.Diagnostics": "1.0.0-beta1"

},

輸入時(shí)， Visual Studio 會(huì)提供智能提示：

接下來，打開 Startup.cs 文件，添加以下代碼：

using System;

using Microsoft.AspNet.Builder;

namespace TodoApi

{

    public class Startup

    {

        public void Configure(IApplicationBuilder app)

        {

            // New code

            app.UseWelcomePage();

        }

    }

}

點(diǎn)擊  F5 運(yùn)行，Visual Studio 啟動(dòng)瀏覽器，打開了 http://localhost:port/，端口號(hào)是一個(gè)Visual Studio隨機(jī)分配的數(shù)字。運(yùn)行效果如下：

歡迎界面是檢驗(yàn)運(yùn)行效果的快速入口，無需編寫代碼。

創(chuàng)建 Web API

在本章節(jié)中，您將創(chuàng)建一個(gè) ToDo 事項(xiàng)管理列表功能API。首先，我們需要添加 ASP.NET MVC 6 到應(yīng)用中。

添加 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 需要的所有依賴項(xiàng)，會(huì)自動(dòng)在啟動(dòng)時(shí)調(diào)用ConfigureServices 。

  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 代表應(yīng)用的數(shù)據(jù)域。在本示例中，model 中存儲(chǔ) ToDo 項(xiàng)。 添加以下類到項(xiàng)目中：

  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; }

      }

  }

   

  為了保持項(xiàng)目的整潔，我創(chuàng)建了 Models 文件夾用于存放 Model 類，當(dāng)然這不是必要的操作。

  添加 Controller

  添加 controller 類用于處理 HTTP 請(qǐng)求。添加以下類到項(xiàng)目中：

  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

          }

      }

  }

   

  同樣，我創(chuàng)建了 Controllers 文件夾用于存儲(chǔ) controller。

  在后續(xù)的章節(jié)中我們將進(jìn)一步闡述關(guān)于 Controller 的代碼。以下是 controller 實(shí)現(xiàn)的一些基礎(chǔ)功能：

  

  例如，下面是獲取 ToDo 項(xiàng)目的 HTTP 請(qǐng)求的：

  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}]

  后續(xù)章節(jié)中我們將闡述以下內(nèi)容：

  • 在配置方法中添加以下代碼，UseMvc 方法用于添加 MVC 6 到管道。

• 如何配置 ASP.NET 5.0 管道。

• 在 IIS 外對(duì)立部署應(yīng)用。

   

  原文鏈接：Create a Web API in MVC 6

系列文章目錄：

• ASP.NET 5系列教程 (一)：領(lǐng)讀新特性

• ASP.NET 5系列教程 (二)：Hello World

• ASP.NET 5系列教程 (三)：view components介紹

• ASP.NET 5系列教程 (四)：向視圖中添加服務(wù)和發(fā)布應(yīng)用到公有云

• ASP.NET 5系列教程 (五)：在Visual Studio 2015中使用Grunt、Bower開發(fā)Web程序