使用.NET Core构建简单REST API：分步指南

准备好创建您的第一个 .NET Core Web API 吗？通过本教程，您将学习如何在几分钟内构建一个功能齐全的 REST API。以下是分步指南，帮助您快速上手并掌握核心概念。

🛠 第一步：初始化项目

首先，您需要创建一个新的 .NET Core Web API 项目。在终端中运行以下命令：

dotnet new webapi -n TodoApi
cd TodoApi

运行上述命令后，项目目录将包含以下关键文件：

• Controllers/：存放 API 端点的文件夹。
• Program.cs：在 .NET 6+ 中替代了传统的 Startup.cs 文件。

🏗 第二步：添加模型

在本步骤中，我们将定义数据模型并配置内存数据库。

1. 创建模型文件 Models/Todo.cs

在项目中创建一个名为 Todo.cs 的文件，并添加以下代码：

public class Todo
{
    public int Id { get; set; }
    public string? Title { get; set; }
    public bool IsComplete { get; set; }
}

2. 添加 Entity Framework Core 支持

运行以下命令，添加内存数据库的支持：

dotnet add package Microsoft.EntityFrameworkCore.InMemory

3. 创建数据上下文 Data/TodoContext.cs

接下来，创建一个名为 TodoContext.cs 的文件，并添加以下代码：

public class TodoContext : DbContext
{
    public TodoContext(DbContextOptions options)
        : base(options) { }

    public DbSet Todos => Set();
}

4. 在 Program.cs 中注册服务

最后，修改 Program.cs 文件，注册内存数据库服务：

builder.Services.AddDbContext(opt =>
    opt.UseInMemoryDatabase("TodoList"));

🎯 第三步：构建控制器

控制器是 REST API 的核心部分，用于处理客户端请求并返回响应。

创建控制器文件 Controllers/TodosController.cs

在 Controllers 文件夹中创建一个名为 TodosController.cs 的文件，并添加以下代码：

[ApiController]
[Route("[controller]")]
public class TodosController : ControllerBase
{
    private readonly TodoContext _context;

    public TodosController(TodoContext context)
    {
        _context = context;
    }    // GET: /todos
    [HttpGet]
    public async Task<ActionResult<IEnumerable>> GetTodos()
    {
        return await _context.Todos.ToListAsync();
    }    // GET: /todos/5
    [HttpGet("{id}")]
    public async Task<ActionResult> GetTodo(int id)
    {
        var todo = await _context.Todos.FindAsync(id);
        return todo == null ? NotFound() : todo;
    }    // POST: /todos
    [HttpPost]
    public async Task<ActionResult> PostTodo(Todo todo)
    {
        _context.Todos.Add(todo);
        await _context.SaveChangesAsync();
        return CreatedAtAction(nameof(GetTodo), new { id = todo.Id }, todo);
    }
}

🔥 第四步：测试您的 API

完成上述步骤后，您可以运行以下命令启动应用程序：

dotnet run

启动后，您可以使用工具（如 Postman 或浏览器）访问以下端点：

• GET /todos：获取所有任务。
• GET /todos/{id}：根据 ID 获取单个任务。
• POST /todos：创建新任务。

💡 已实施的最佳实践

在本教程中，我们采用了以下最佳实践：

• 正确的 HTTP 状态代码：如 201（已创建）、404（未找到）。
• 异步编程：通过 async/await 提高可扩展性。
• 清晰的职责分离：将模型、数据上下文和控制器分开。
• 依赖注入：简化服务的管理和测试。

🚀 下一步

完成本教程后，您可以尝试以下高级功能：

• 添加身份验证：通过 JWT 实现安全访问。
• 连接真实数据库：如 SQL Server 或 PostgreSQL。
• 使用 DTO（数据传输对象）：优化请求和响应的数据结构。

完整的源代码可以在 GitHub 上找到，欢迎参考并进一步扩展您的项目！

原文链接: https://www.sarikayadev.com/en-US/blog/building-a-simple-rest-api-with-net-core-step-by-step-guide