ASP.NET Core WebAPI 入门学习笔记

1. 什么是 ASP.NET Core WebAPI

ASP.NET Core WebAPI 是一个开源的、跨平台的框架，用于构建 Web 服务和 API，以便于不同平台间的数据交互。它是 ASP.NET Core 的一部分，提供了一种方便的方式来构建可以与各种平台（移动设备、Web 应用、桌面应用）进行通信的 RESTful 服务。

2. 创建一个简单的 WebAPI 项目

要开始一个新的 ASP.NET Core WebAPI 项目，您可以使用 Visual Studio、Visual Studio Code 或 .NET CLI。以下是使用 .NET CLI 创建一个 WebAPI 项目的步骤：

步骤 1: 安装 .NET SDK

首先，确保您已经安装了 .NET SDK，可以通过以下命令检查：

dotnet --version

如果没有安装，可以前往 Microsoft .NET 官网 下载并安装。

步骤 2: 创建 WebAPI 项目

打开终端，输入以下命令：

dotnet new webapi -n MyWebApi

这将创建一个名为 MyWebApi 的新项目。

步骤 3: 运行项目

进入项目目录并运行：

cd MyWebApi
dotnet run

默认情况下，API 将在 http://localhost:5000 和 https://localhost:5001 上提供服务。您可以在浏览器中访问这些地址查看默认提供的 API 文档。

3. 理解控制器

在 WebAPI 中，控制器是处理 HTTP 请求的主要组件。创建控制器非常简单，只需在 Controllers 文件夹中添加一个新类，继承自 ControllerBase。

以下是一个简单的控制器示例，实现了基本的 CRUD 操作：

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

namespace MyWebApi.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class ProductController : ControllerBase
    {
        private static List<string> products = new List<string>
        {
            "Product A",
            "Product B"
        };

        // GET: /product
        [HttpGet]
        public ActionResult<List<string>> GetAll()
        {
            return Ok(products);
        }

        // GET: /product/{id}
        [HttpGet("{id}")]
        public ActionResult<string> Get(int id)
        {
            if (id < 0 || id >= products.Count)
                return NotFound();
            return Ok(products[id]);
        }

        // POST: /product
        [HttpPost]
        public ActionResult Create([FromBody] string product)
        {
            products.Add(product);
            return CreatedAtAction(nameof(Get), new { id = products.Count - 1 }, product);
        }

        // DELETE: /product/{id}
        [HttpDelete("{id}")]
        public ActionResult Delete(int id)
        {
            if (id < 0 || id >= products.Count)
                return NotFound();
            products.RemoveAt(id);
            return NoContent();
        }
    }
}

4. 测试 API

我们可以使用 Postman 或者 cURL 来测试上述 API。以下是一些测试用例：

获取所有产品

GET http://localhost:5000/product

根据 ID 获取产品

GET http://localhost:5000/product/0

创建新产品

POST http://localhost:5000/product
Content-Type: application/json

"Product C"

删除产品

DELETE http://localhost:5000/product/1

5. 数据持久化

在实际应用中，数据通常需要持久化存储。ASP.NET Core 支持多种数据库，可以使用 Entity Framework Core 来方便地与数据库进行交互。具体集成过程较为复杂，建议查阅官方文档或者相关教程。

6. 总结

本篇笔记简单介绍了 ASP.NET Core WebAPI 的基本概念和创建步骤。通过这一简单的示例，我们可以了解到如何构建 RESTful API，并进行基本的创建、读取、更新和删除操作。后续可以进一步探索中间件、身份认证、错误处理等高级主题，以便于构建更复杂的应用。

希望本篇学习笔记能帮助你更快地入门 ASP.NET Core WebAPI！