C# 如何实现一个简单的Web API - ASP.NET Core Minimal APIs入门

ASP.NET Core Minimal APIs 是从 .NET 6 开始引入的轻量级 Web API 开发方式,仅需少量代码即可定义 HTTP 接口,无需控制器和复杂结构,适合原型开发、微服务及简单后端。

想快速搭建一个轻量级的Web API?ASP.NET Core Minimal APIs 是个理想选择。它从 .NET 6 开始引入,让你用极少的代码定义 HTTP 接口,无需控制器或复杂的项目结构。适合原型开发、微服务或简单后端接口。

创建 Minimal API 项目

打开终端,运行以下命令创建新项目:

dotnet new web -n MyMinimalApi
cd MyMinimalApi
dotnet run

这会生成一个极简的 ASP.NET Core 项目,包含一个 Program.cs 文件,没有 Controllers 文件夹。默认代码已实现一个返回 "Hello World!" 的 GET 接口。

定义基本路由和HTTP方法

Minimal APIs 使用委托来处理请求,直接在 WebApplication 实例上注册路由。例如:

  • GET 请求:获取数据
app.MapGet("/hello", () => "Hello from Minimal API");
  • POST 请求:接收 JSON 数据
  • app.MapPost("/data", (User user) => Results.Ok($"Received: {user.Name}"));

    其中 User 是一个简单的类:

    record User(string Name, int Age);
    • PUT/DELETE:更新或删除资源
    • app.MapPut("/user/{id}", (int id, User user) => Results.NoContent());
      app.MapDelete("/user/{id}", (int id) => Results.Ok($"Deleted user {id}"));

      返回不同响应类型

      使用 Results 静态类可以方便地返回标准 HTTP 响应:

      • Results.Ok(data):返回 200 和数据
      • Results.NotFound():返回 404
      • Results.BadRequest():返回 400
      • Results.Created(path, data):返回 201 和创建的资源

      示例:

      app.MapGet("/users/{id}", (int id) =>
      {
      if (id == 1) return Results.Ok(new User("Alice", 30));
      return Results.NotFound();
      });

      启用跨域和添加Swagger

      开发中常需 Swagger 查看接口和跨域支持。在 Program.cs 添加:

      builder.Services.AddEndpointsApiExplorer();
      builder.Services.AddSwaggerGen();

      并在中间件中启用:

      if (app.Environment.IsDevelopment())
      {
      app.UseSwagger();
      app.UseSwaggerUI();
      }

      访问 https://localhost:5001/swagger 即可查看 API 文档。

      基本上就这些。Minimal APIs 把简洁做到了极致,适合快速交付小功能。随着需求增长,也可以逐步引入依赖注入、验证、日志等特性。不复杂但容易忽略细节,比如模型绑定和错误处理,后续可按需扩展。