项目5 - Web API 接口开发

嗨，朋友！我是长安。

恭喜你来到最后一个项目！这次我们要开发一个完整的 Web API 应用，学习 ASP.NET Core Web API 的核心概念，实现 RESTful 风格的接口，为前端或移动端提供数据服务。这是从控制台应用到 Web 开发的重要跨越！

🎯 项目目标

通过这个项目，你将:

掌握 ASP.NET Core Web API 基础
学会设计和实现 RESTful API
理解 HTTP 协议和 REST 原则
学会使用依赖注入(DI)
掌握异步编程
学会 API 测试方法
理解前后端分离架构

📁 项目结构

TodoApi/
├── Controllers/
│   └── TodosController.cs
├── Models/
│   ├── TodoItem.cs
│   ├── CreateTodoDto.cs
│   └── UpdateTodoDto.cs
├── Services/
│   ├── ITodoService.cs
│   └── TodoService.cs
├── Program.cs
└── appsettings.json

🎯 项目需求

API 功能列表

我们将开发一个 任务管理 API (TodoAPI):

GET /api/todos - 获取所有任务
GET /api/todos/{id} - 获取单个任务
POST /api/todos - 创建新任务
PUT /api/todos/{id} - 更新任务
DELETE /api/todos/{id} - 删除任务
PATCH /api/todos/{id}/complete - 标记完成
GET /api/todos/stats - 获取统计

技术栈

ASP.NET Core 6.0+ - Web API 框架
RESTful 设计 - REST 架构风格
JSON - 数据格式
依赖注入 - DI 模式
异步编程 - async/await
Swagger/OpenAPI - API 文档

项目创建

dotnet new webapi -n UserApi
cd UserApi
dotnet run

核心代码

[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    private static List<User> users = new List<User>
    {
        new User { Id = 1, Name = "张三", Email = "zhang@example.com" },
        new User { Id = 2, Name = "李四", Email = "li@example.com" }
    };

    [HttpGet]
    public ActionResult<IEnumerable<User>> GetAll()
    {
        return Ok(users);
    }

    [HttpGet("{id}")]
    public ActionResult<User> GetById(int id)
    {
        var user = users.FirstOrDefault(u => u.Id == id);
        if (user == null)
            return NotFound();
        return Ok(user);
    }

    [HttpPost]
    public ActionResult<User> Create(User user)
    {
        user.Id = users.Max(u => u.Id) + 1;
        users.Add(user);
        return CreatedAtAction(nameof(GetById), new { id = user.Id }, user);
    }

    [HttpPut("{id}")]
    public ActionResult Update(int id, User user)
    {
        var existingUser = users.FirstOrDefault(u => u.Id == id);
        if (existingUser == null)
            return NotFound();
        
        existingUser.Name = user.Name;
        existingUser.Email = user.Email;
        return NoContent();
    }

    [HttpDelete("{id}")]
    public ActionResult Delete(int id)
    {
        var user = users.FirstOrDefault(u => u.Id == id);
        if (user == null)
            return NotFound();
        
        users.Remove(user);
        return NoContent();
    }
}

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

🧪 测试 API

使用 Postman 或浏览器测试：

GET    http://localhost:5000/api/users
GET    http://localhost:5000/api/users/1
POST   http://localhost:5000/api/users
PUT    http://localhost:5000/api/users/1
DELETE http://localhost:5000/api/users/1

📚 知识点总结

知识点	说明	应用
ASP.NET Core	Web 框架	整个项目
RESTful API	REST 风格	API 设计
HTTP 动词	GET/POST/PUT/DELETE	CRUD 操作
路由	属性路由	`[Route]`、`[HttpGet]`
模型绑定	参数绑定	`[FromBody]`、DTO
数据验证	DataAnnotations	`[Required]`
依赖注入	DI 模式	服务注册
异步编程	async/await	异步方法
Swagger	API 文档	文档生成

💡 优化建议

1. 添加异常处理

public class ErrorHandlingMiddleware
{
    private readonly RequestDelegate _next;
    
    public ErrorHandlingMiddleware(RequestDelegate next)
    {
        _next = next;
    }
    
    public async Task InvokeAsync(HttpContext context)
    {
        try
        {
            await _next(context);
        }
        catch (Exception ex)
        {
            context.Response.StatusCode = 500;
            await context.Response.WriteAsJsonAsync(new { error = ex.Message });
        }
    }
}

2. 添加 CORS

builder.Services.AddCors(options =>
{
    options.AddPolicy("AllowAll",
        builder => builder.AllowAnyOrigin().AllowAnyMethod().AllowAnyHeader());
});

app.UseCors("AllowAll");