ASP.NET Core是微软推出的跨平台高性能Web开发框架,本文通过一个完整的实例讲解如何使用它实现基础Web API接口,帮助开发者快速掌握核心开发流程。

项目创建与基础配置
首先通过命令行或者Visual Studio创建一个ASP.NET Core Web API项目,项目创建完成后会自动生成基础的文件结构,其中Program.cs是项目的入口文件,所有的核心配置都在这里完成。
下面是Program.cs的基础配置代码,我们添加了一个简单的日志中间件和控制器服务:
var builder = WebApplication.CreateBuilder(args);
// 添加控制器服务
builder.Services.AddControllers();
// 添加内存缓存服务示例,演示依赖注入的基础用法
builder.Services.AddMemoryCache();
var app = builder.Build();
// 配置中间件,这里添加自定义日志中间件
app.Use(async (context, next) =>
{
Console.WriteLine($"请求路径:{context.Request.Path}");
await next();
});
// 映射控制器路由
app.MapControllers();
app.Run();
实现基础控制器与接口
控制器是ASP.NET Core中处理HTTP请求的核心组件,我们通过创建一个用户相关的控制器来演示接口的实现逻辑。
创建用户模型
首先定义用户的数据模型,用来作为接口的请求和返回参数:
namespace ASPNETCoreDemo.Models
{
public class User
{
public int Id { get; set; }
public string Name { get; set; }
public int Age { get; set; }
}
}
编写控制器逻辑
创建UsersController控制器,实现获取用户列表和根据ID获取用户的接口,同时使用依赖注入注入内存缓存服务:
using ASPNETCoreDemo.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Caching.Memory;
namespace ASPNETCoreDemo.Controllers
{
[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
private readonly IMemoryCache _cache;
// 构造器注入内存缓存服务
public UsersController(IMemoryCache cache)
{
_cache = cache;
}
// 模拟的用户数据源
private static readonly List<User> _users = new List<User>
{
new User { Id = 1, Name = "张三", Age = 20 },
new User { Id = 2, Name = "李四", Age = 22 }
};
// GET api/users 获取用户列表
[HttpGet]
public IActionResult GetUsers()
{
// 尝试从缓存获取用户列表
if (!_cache.TryGetValue("user_list", out List<User> userList))
{
userList = _users;
// 设置缓存,有效期10分钟
_cache.Set("user_list", userList, TimeSpan.FromMinutes(10));
}
return Ok(userList);
}
// GET api/users/{id} 根据ID获取用户
[HttpGet("{id}")]
public IActionResult GetUserById(int id)
{
var user = _users.FirstOrDefault(u => u.Id == id);
if (user == null)
{
return NotFound($"未找到ID为{id}的用户");
}
return Ok(user);
}
// POST api/users 新增用户
[HttpPost]
public IActionResult AddUser([FromBody] User user)
{
user.Id = _users.Max(u => u.Id) + 1;
_users.Add(user);
// 新增用户后移除缓存
_cache.Remove("user_list");
return CreatedAtAction(nameof(GetUserById), new { id = user.Id }, user);
}
}
}
接口测试与验证
启动项目后,可以通过Postman或者curl工具测试接口功能:
- 访问
api/users可以获取所有用户列表,首次访问会写入缓存,后续请求会直接读取缓存 - 访问
api/users/1可以获取ID为1的用户信息 - 发送POST请求到
api/users,携带用户JSON数据可以新增用户,新增后缓存会自动移除
核心知识点总结
| 知识点 | 说明 |
|---|---|
| 中间件 | 请求处理管道中的组件,可处理请求和响应,按顺序执行 |
| 依赖注入 | 通过构造器注入服务,降低组件之间的耦合度,提升代码可维护性 |
| 控制器路由 | 通过[Route]和[HttpGet]等特性定义接口的访问路径和请求方式 |
| 模型绑定 | 自动将请求参数绑定到方法的参数对象上,比如[FromBody]绑定请求体内容 |
通过这个实例,开发者可以快速掌握ASP.NET Core Web API的基础开发流程,后续可以在此基础上扩展更复杂的业务逻辑,比如添加数据库操作、身份认证等功能。
ASP.NET_CoreWeb_API依赖注入中间件控制器修改时间:2026-06-20 01:51:30