最小 API 概觀

注意

這不是這篇文章的最新版本。 如需目前版本,請參閱本文的 .NET 8 版本

警告

不再支援此版本的 ASP.NET Core。 如需詳細資訊,請參閱 .NET 和 .NET Core 支援原則。 如需目前版本,請參閱本文的 .NET 8 版本

重要

這些發行前產品的相關資訊在產品正式發行前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。

如需目前版本,請參閱本文的 .NET 8 版本

基本 API 是使用 ASP.NET Core 建置快速 HTTP API 的簡化方法。 您可以使用最少的程式碼和設定,來建置功能完整的 REST 端點。 透過流暢地宣告 API 路由和動作,略過傳統的 Scaffolding 並避免不必要的控制器。 例如,下列程式碼會在傳回文字 "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