最小 API 概述

注意

此版本不是本文的最新版本。 对于当前版本,请参阅此文的 .NET 8 版本

警告

此版本的 ASP.NET Core 不再受支持。 有关详细信息,请参阅 .NET 和 .NET Core 支持策略。 对于当前版本,请参阅此文的 .NET 8 版本

重要

此信息与预发布产品相关,相应产品在商业发布之前可能会进行重大修改。 Microsoft 对此处提供的信息不提供任何明示或暗示的保证。

对于当前版本,请参阅此文的 .NET 8 版本

在使用 ASP.NET Core 生成快速 HTTP API 时,可以将最小 API 作为一种简化的方法。 可以使用最少的代码和配置生成完全正常运行的 REST 终结点。 跳过传统的基架,并通过流畅地声明 API 路由和操作来避免不必要的控制器。 例如,以下代码在返回文本 "Hello World!" 的 Web 应用的根处创建了一个 API。

var app = WebApplication.Create(args);

app.MapGet("/", () => "Hello World!");

app.Run();

大多数 API 接受参数作为路由的一部分。

var builder = WebApplication.CreateBuilder(args);

var app = builder.Build();

app.MapGet("/users/{userId}/books/{bookId}", 
    (int userId, int bookId) => $"The user id is {userId} and book id is {bookId}");

app.Run();

这就是开始使用的内容,但这并不是全部。 最小 API 支持缩放到多个 API、处理复杂路由、应用授权规则和控制 API 响应内容所需的配置和自定义。 教程:使用 ASP.NET Core 创建最小 API 非常适合用于入门学习。

想要查看一些代码示例?

有关包含代码示例的常见应用场景的完整列表,请参阅最小 API 快速参考

想要跳过并直接开始你的第一个项目?

使用我们的教程生成最小 API 应用:教程:使用 ASP.NET Core 创建最小 API