Asp.Net Core 5 REST API – Step by Step

翻譯自 Mohamad Lawand 2021年1月19日的文章 《Asp.Net Core 5 Rest API Step by Step》 [1]

在本文中，我們將創建一個簡單的 Asp.Net Core REST API Todo 應用程式，在其中我們可以添加、編輯、刪除和查看待辦事項，並且將使用 SQLite 來存儲數據。

你也可以在 YouTube 上觀看完整的影片[2]，還可以下載源程式碼[3]。

這是 API 開發系列的第一部分，後面還有：

Asp.Net Core 5 REST API

在開始之前，我們需要準備的四樣東西：

下載並安裝了所有必需的工具後，我們需要確保 dotnet SDK 已成功安裝，我們需要打開終端並通過檢查 dotnet 版本來檢查 dotnet SDK 是否已成功安裝。

打開終端並輸入以下命令：

dotnet --version

現在，我們需要安裝 EntityFramework 工具：

dotnet tool install --global dotnet-ef

完成後，我們需要創建我們的應用程式：

dotnet new webapi -n "TodoApp" -lang "C#" -au none

現在讓我們添加需要使用的依賴包，以便可以使用 EntityFramrwork 和 SQLite：

dotnet add package Microsoft.EntityFrameworkCore.Sqlite
dotnet add package Microsoft.EntityFrameworkCore.Tools

現在，請打開 VS Code 並檢查我們的應用程式和源程式碼，然後，讓我們構建應用程式並查看其是否可以運行：

dotnet build
dotnet run

確認可以正常運行後，我們刪除由 .Net Core 框架為我們生成的默認模板程式碼，即刪除 WeatherForcastController 和WeatherForcast 類。

接著，我們創建自己的控制器，將其命名為 TodoController。

然後，我們創建第一個簡單的 Action，將其命名為 TestRun，讓我們開始為我們的控制器編碼：

[Route("api/[controller]")] // 我們定義控制器要使用的路由
[ApiController] // 我們需要指定控制器的類型以讓 .Net Core 知道
public class TodoController : ControllerBase
{
    [Route("TestRun")] // 定義此 Action 的路由
    [HttpGet]
    public ActionResult TestRun()
    {
        return Ok("success");
    }
}

創建完成後，我們需要對其進行測試，為了測試，我們需要執行以下操作：

dotnet build
dotnet run

應用程式運行起來後，我們可以打開 Postman 試一下看看我們得到的響應。

我們在 Postman 中創建一個新請求，並將類型設置為 GET，然後請求以下 URL：

//localhost:5001/api/todo/testrun

正如您在 TestRun 中看到的那樣，我們在 Postman 中得到了 「success」 響應。

測試完之後，我們現在需要開始添加模型，在根目錄中添加一個 Models 文件夾，並在其中添加一個名為 ItemData 的類。這是一個非常簡單的模型，它表示我們的待辦事項的列表項。

public class ItemData
{
    public int Id { get; set; }
    public string Title { get; set; }
    public string Description { get; set; }
    public bool Done { get; set; }
}

添加好模型後，我們需要構建 ApiDbContext。在根目錄中創建一個 Data 文件夾，然後在該文件夾中創建一個名為 ApiDbContext 的新類。

public class ApiDbContext : DbContext
{
    public virtual DbSet<ItemData> Items {get;set;}

    public ApiDbContext(DbContextOptions<ApiDbContext> options)
        : base(options)
    {
        
    }
}

然後，我們需要在 appsetting.json 中指定應用程式的連接字元串：

"ConnectionStrings": {
  "DefaultConnection" : "DataSource=app.db; Cache=Shared"
}

完善 DbContext 和連接字元串後，我們需要更新 Startup 類，以便可以在應用程式中使用 Application DbContext。在我們的根目錄中打開 Startup 類，然後添加以下程式碼：

services.AddDbContext<ApiDbContext>(options =>
    options.UseSqlite(
        Configuration.GetConnectionString("DefaultConnection")
    ));

添加好 DbContext 中間件後，我們需要添加初始化遷移來創建資料庫：

dotnet ef migrations add "Initial Migrations"
dotnet ef database update

成功完成資料庫更新後，我們可以看到有一個名為 Migrations 的新文件夾，它將包含 C# 腳本，該腳本將負責創建資料庫及其表 Items。我們可以在根目錄中看到 app.db 文件，也可以使用 SQLite 查看工具來驗證表是否已成功創建，由此我們可以驗證資料庫是否已創建。

現在，我們已經完成了控制器的所有基礎設施的搭建。現在，我們需要開始構建 TodoController 並將其連接到ApiDbContext。

我們從添加獲取待辦事項中的所有項的方法 GetItems 開始，依次添加所有需要的方法：

using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore;
using TodoApp.Data;
using TodoApp.Models;

namespace TodoApp.Controllers
{
    [Route("api/[controller]")] // api/todo
    [ApiController]
    public class TodoController : ControllerBase
    {
        private readonly ApiDbContext _context;

        public TodoController(ApiDbContext context)
        {
            _context = context;
        }

        [HttpGet]
        public async Task<IActionResult> GetItems()
        {
            var items = await _context.Items.ToListAsync();
            return Ok(items);
        }

        [HttpPost]
        public async Task<IActionResult> CreateItem(ItemData data)
        {
            if (ModelState.IsValid)
            {
                await _context.Items.AddAsync(data);
                await _context.SaveChangesAsync();

                return CreatedAtAction("GetItem", new { data.Id }, data);
            }

            return new JsonResult("Something went wrong") { StatusCode = 500 };
        }

        [HttpGet("{id}")]
        public async Task<IActionResult> GetItem(int id)
        {
            var item = await _context.Items.FirstOrDefaultAsync(x => x.Id == id);

            if (item == null)
                return NotFound();

            return Ok(item);
        }

        [HttpPut("{id}")]
        public async Task<IActionResult> UpdateItem(int id, ItemData item)
        {
            if (id != item.Id)
                return BadRequest();

            var existItem = await _context.Items.FirstOrDefaultAsync(x => x.Id == id);

            if (existItem == null)
                return NotFound();

            existItem.Title = item.Title;
            existItem.Description = item.Description;
            existItem.Done = item.Done;

            // 在資料庫級別實施更改
            await _context.SaveChangesAsync();

            return NoContent();
        }

        [HttpDelete("{id}")]
        public async Task<IActionResult> DeleteItem(int id)
        {
            var existItem = await _context.Items.FirstOrDefaultAsync(x => x.Id == id);

            if (existItem == null)
                return NotFound();

            _context.Items.Remove(existItem);
            await _context.SaveChangesAsync();

            return Ok(existItem);
        }
    }
}

然後，我們可以在 Postman 中一個一個地對它們進行測試。

最後，由於我們在創建 Web API 項目時使用的是 .Net 5，因此 Swagger 已經集成到了我們的應用程式中，要查看 Swagger 介面，可以在瀏覽器中導航到 //localhost:5000/swagger/index.html。

Swagger 允許您描述 API 的結構，以便程式可以自動讀取它們，而無需我們額外的工作。Swagger 能夠讀取 API 結構並為我們生成一個 UI，我們可以藉此來改善開發體驗。

感謝您閱讀本文。

本文是 API 開發系列的第一部分，後面會有第二、第三部分。

作者 ： Mohamad Lawand
譯者 ： 技術譯民
出品 ： 技術譯站
鏈接 ： 英文原文

  1. //dev.to/moe23/asp-net-core-5-rest-api-step-by-step-2mb6 Asp.Net Core 5 Rest API Step by Step ↩︎

  2. //youtu.be/p_wUdWshYc8 ↩︎

  3. //github.com/mohamadlawand087/v6-RestApiNetCore5 ↩︎

  4. //mp.weixin.qq.com/s/zR0Yz0eUYXzSrctYmE2oWg Asp.Net Core 5 REST API 使用 JWT 身份驗證 – Step by Step ↩︎

Tags:

VirMach 便宜 VPS

QNews

QNews