Asp.NET Core WebAPI 入門學習筆記,超詳細

在開始學習 ASP.NET Core Web API 之前,瞭解其基礎概念是非常重要的。ASP.NET Core 是 Microsoft 提供的一個開放源代碼且跨平臺的框架,用於構建基於雲的、模塊化的網絡應用。它包含了一系列特性來幫助開發者快速開發高性能的 web 應用程序和 RESTful APIs。而 Web API 則是使用 ASP.NET Core 創建服務端程序的一種方式,它可以處理來自前端客戶端的請求,返回數據或執行操作。

安裝環境準備

首先,您需要確保您的計算機上已經安裝了 .NET Core SDK 和 Visual Studio Code(或者 Visual Studio)。如果您還沒有這些工具,請從官方網站下載最新版本進行安裝。

創建一個新的Web API項目

打開Visual Studio Code,選擇“文件”->“新建文件夾”來創建一個新項目目錄。然後在該目錄中右鍵點擊,選擇“打開Folder in Terminal”(如果使用的是Windows系統)或“Open Folder in Integrated Terminal”(如果是Mac或Linux系統)。在這個終端窗口中運行以下命令以初始化一個新的ASP.NET Core Web API項目:

dotnet new webapi -o MyFirstApiProject

這條命令將在當前目錄下生成一個新的名爲 `MyFirstApiProject` 的項目文件夾,其中包括所有的必需文件。

理解項目結構

接下來,讓我們簡要了解一下生成的項目中的主要文件及其作用:

  • Program.cs:這是項目的入口點,它負責啓動並配置應用程序。
  • Startup.cs:這個類定義了應用的管道如何配置以及中間件如何添加。
  • Controllers/:所有控制器類的默認位置,它們處理HTTP請求並返回響應。
  • Models/:實體模型和相關數據的存儲位置。
  • appsettings.json:應用程序設置文件的默認位置,例如連接字符串和其它配置信息。

編寫第一個控制器

爲了演示如何通過 Web API 發送和接收數據,我們將創建一個簡單的 “Hello World” 控制器。打開 `Controlles/ValuesController.cs` 文件,替換其中的內容如下所示:

using System;
using Microsoft.AspNetCore.Mvc;

namespace MyFirstApiProject.Controllers
{
[Route("api/[controller]")]
public class ValuesController : ControllerBase
{
// GET api/values
[HttpGet]
public IActionResult Get()
{
return Ok(new { message = "Hello, world!" });
}
}
}

這裏我們重寫了 `Get()` 方法,它將返回一個 JSON 格式的對象,內容爲 “Hello, world!”。

測試我們的Web API

現在我們可以通過運行以下命令來編譯和運行我們的應用程序:

dotnet run

這將會在控制檯中顯示類似於這樣的輸出:

Now listening on: http://localhost:<port>
Application started. Press Ctrl+C to shut down.

這裏的 “ 會被實際的端口號代替,例如可能是 `http://localhost:5001`。在瀏覽器中輸入這個地址,你應該會看到類似如下的JSON響應:

{"message":"Hello, world!"}

這表明我們的 Web API 正在運行並且可以正確地響應用戶請求。

在這篇文章中,我們介紹瞭如何開始使用 ASP.NET Core Web API 來創建一個簡單的 RESTful API。我們學習瞭如何創建一個新的項目、理解項目結構、編寫第一個控制器以及如何在本地環境中測試我們的應用程序。這是一個很好的起點,你可以在此基礎上繼續深入學習更多關於 ASP.NET Core Web API 的知識,比如身份驗證、授權、依賴注入等等。

为您推荐