.NET的API功能

Table of contents

• 背景
  • 步驟1：安裝 Visual Studio
  • 步驟2：建立 ASP.NET Core 項目
  • 步驟3：撰寫與啟動 API
  • 步驟4：啟動項目

---

背景

ASP.NET Core 提供了強大的 API 開發功能，透過 MVC 框架和 Web API 控制器，你可以輕鬆建立和管理 API。 以下是一個簡單的 ASP.NET Core API 的啟動和範例說明。

步驟1：安裝 Visual Studio

如果你還沒安裝 Visual Studio，可以在 Visual Studio 官網 下載並安裝 Visual Studio。

步驟2：建立 ASP.NET Core 項目

1. 開啟 Visual Studio。
2. 選擇 “Create a new project”。
3. 在搜尋框中輸入 “ASP.NET Core Web Application”，選擇 “ASP.NET Core Web Application” 範本。
4. 按一下 “Next”。
5. 在 “Configure your new project” 頁面，選擇 “API” 範本。
6. 點選 “Create”。

步驟3：撰寫與啟動 API

在專案中，有一個 Controllers 資料夾，裡麵包含 ValuesController.cs 檔案。 我們將修改這個文件，以便示範一個簡單的 API。

using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;

namespace YourNamespace.Controllers
{
     [Route("api/[controller]")]
     [ApiController]
     public class ValuesController : ControllerBase
     {
         // GET: api/values
         [HttpGet]
         public ActionResult<IEnumerable<string>> Get()
         {
             return new string[] { "value1", "value2" };
         }

         // GET: api/values/5
         [HttpGet("{id}")]
         public ActionResult<string> Get(int id)
         {
             return "value";
         }

         // POST: api/values
         [HttpPost]
         public void Post([FromBody] string value)
         {
             // Handle the POST request
         }

         // PUT: api/values/5
         [HttpPut("{id}")]
         public void Put(int id, [FromBody] string value)
         {
             // Handle the PUT request
         }

         // DELETE: api/values/5
         [HttpDelete("{id}")]
         public void Delete(int id)
         {
             // Handle the DELETE request
         }
     }
}

這個 ValuesController 包含了一些基本的 HTTP 動作（GET、POST、PUT、DELETE）。 這只是一個簡單的範例，你可以根據專案需求進行更複雜的實作。

步驟4：啟動項目

1. 選擇專案中的 Properties 資料夾。
2. 雙擊 launchSettings.json 檔案。
3. 在 launchUrl 中，確保設定為 "launchUrl": "api/values"。
4. 按 F5 或按一下 Visual Studio 中的 “Start Debugging”。

專案將啟動，瀏覽器將開啟 API 位址（通常是 https://localhost:xxxx/api/values）。 你可以使用工具（如 Postman 或瀏覽器）來測試 API 的各種端點。

這是一個簡單的範例，幫助你了解如何建立和啟動 ASP.NET Core API 專案。 在實際專案中，你可能需要處理更複雜的資料、新增身份驗證、使用資料庫等。