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 實現的一些基礎功能:

    image

    例如,下面是獲取 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的理解又加深了一步。在進行開發時,還可以借助一些開發工具。ComponentOne Studio for ASP.NET 是ASP.NET平台上的一整套完備的開發工具包,用於在各種瀏覽器中創建和設計具有現代風格的Web應用程序。

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

 

系列文章目錄:


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM