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

時間  2019-11-06
標籤 asp.net asp 系列 教程 mvc6 mvc 建立 web api 欄目 ASP 简体版
原文   原文鏈接

ASP.NET 5.0 的主要目標之一是統一MVC 和 Web API 框架應用。html

接下來幾篇文章中您會了解如下內容：web

  • ASP.NET MVC 6 中建立簡單的web API。json

  • 如何從空的項目模板中啓動，及添加控件到應用中。api

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

  • 在 IIS 外對立部署應用。mvc

本文的目的是從空的項目開始，逐步講解如何建立應用。固然，您也能夠從「Starter Web」 模板開始，它默認包含了MVC 六、權限、記錄等其餘模塊，同時也內置了有效的控制器和視圖在其中。app

建立空的 ASP.NET 5 項目

打開 Visual Studio 2015。點擊 File 菜單，選擇 New > Project。框架

在 New Project 對話框中，點擊 Templates > Visual C# > Web，選擇 ASP.NET Web Application 項目模板。命名爲 "TodoApi"，點擊 OK。asp.net

在 New ASP.NET Project 對話框中，選擇 "ASP.NET 5.0 Empty" 模板。grunt

下面的效果圖展現了工程結構：

工程包含如下文件：

  • global.json 包含了解決方案級別的設置，容許工程到工程之間的引用。

  • project.json 包含了工程級別的設置。

  • Project_Readme.html  爲 readme 文件。

  • Startup.cs 包含啓動和配置代碼。

Startup.cs 文件中的Startup 類，配置了 ASP.NET 需求管道。當你使用空的項目模板，Startup 類不會有任何實質性的代碼加入到管道中：

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

 

如今，你能夠運行應用了，但當前的應用沒有任何功能。接下來咱們會模擬"Starter Web" 項目模板來添加功能，例如 MVC 六、Entity Framework、身份驗證、記錄等功能。

添加歡迎界面

打開 project.json 文件。該文件包含了工程設置內容。dependencies 部分用於標註須要的NuGet 包和類庫。添加 Microsoft.AspNet.Diagnostics 包到列表中：

"": {
    "": "",
    // Add this:
    "": ""
},

 

輸入時， Visual Studio 會提供智能提示：

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

 System;
 Microsoft.AspNet.Builder;
 
 
 TodoApi
{
      Startup
    {
         void Configure(IApplicationBuilder app)
        {
            //  code
            app.UseWelcomePage();
        }
    }
}

 

點擊  F5 運行，Visual Studio 啓動瀏覽器，打開了 http://localhost:port/，端口號是一個Visual Studio隨機分配的數字。運行效果以下：

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

建立 Web API

 

在本章節中，您將建立一個 ToDo 事項管理列表功能API。首先，咱們須要添加 ASP.NET MVC 6 到應用中。

添加 MVC 6 到 project.json 文件的依賴列表中：

"": {
    "": "",
    "": "",
    // :
    "": ""
},

 

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

  • 使用 using 聲明Microsoft.Framework.DependencyInjection。

  • 添加如下方法到 Startup 類中。

 void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
}

 

  • 下面這段代碼添加了 MVC 6 須要的全部依賴項，會自動在啓動時調用ConfigureServices 。

     void Configure(IApplicationBuilder app)
    {
        // :
        app.UseMvc();
    }

     

    如下是完整的 Startup 類代碼：

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

     

    添加 Model

    model 表明應用的數據域。在本示例中，model 中存儲 ToDo 項。 添加如下類到項目中：

     System.ComponentModel.DataAnnotations;
     
     TodoApi.Models
    {
          TodoItem
        {
             int Id { ; ; }
            [Required]
              Title { ; ; }
             bool IsDone { ; ; }
        }
    }

     

    爲了保持項目的整潔，我建立了 Models 文件夾用於存放 Model 類，固然這不是必要的操做。

    添加 Controller

    添加 controller 類用於處理 HTTP 請求。添加如下類到項目中：

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

     

    一樣，我建立了 Controllers 文件夾用於存儲 controller。

    在後續的章節中咱們將進一步闡述關於 Controller 的代碼。如下是 controller 實現的一些基礎功能：

    image

    例如，下面是獲取 ToDo 項目的 HTTP 請求的：

     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
    : Thu, 30 Oct 2014 22:40:31 GMT
    Content-Length: 46
     
    [{"":1,"":"","":}]

    後續章節中咱們將闡述如下內容：

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

  • 如何配置 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

 

系列文章目錄：
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程