Udostępnij za pośrednictwem

Przegląd minimalnych interfejsów API

  • Artykuł

Uwaga

Nie jest to najnowsza wersja tego artykułu. Aby zapoznać się z bieżącą wersją, zapoznaj się z wersją tego artykułu platformy .NET 8.

Ostrzeżenie

Ta wersja ASP.NET Core nie jest już obsługiwana. Aby uzyskać więcej informacji, zobacz .NET i .NET Core Support Policy (Zasady obsługi platformy .NET Core). Aby zapoznać się z bieżącą wersją, zapoznaj się z wersją tego artykułu platformy .NET 8.

Ważne

Te informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany, zanim zostanie wydany komercyjnie. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Aby zapoznać się z bieżącą wersją, zapoznaj się z wersją tego artykułu platformy .NET 8.

Minimalne interfejsy API to uproszczone podejście do tworzenia szybkich interfejsów API HTTP przy użyciu platformy ASP.NET Core. Możesz tworzyć w pełni funkcjonalne REST punkty końcowe z minimalnym kodem i konfiguracją. Pomiń tradycyjne tworzenie szkieletów i unikaj niepotrzebnych kontrolerów, płynnie deklarując trasy i akcje interfejsu API. Na przykład poniższy kod tworzy interfejs API w katalogu głównym aplikacji internetowej, która zwraca tekst . "Hello World!"

var app = WebApplication.Create(args);

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

app.Run();

Większość interfejsów API akceptuje parametry w ramach trasy.

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();

To wszystko, co trzeba rozpocząć, ale to nie wszystko, co jest dostępne. Minimalne interfejsy API obsługują konfigurację i dostosowywanie wymagane do skalowania do wielu interfejsów API, obsługę złożonych tras, stosowanie reguł autoryzacji i kontrolowanie zawartości odpowiedzi interfejsu API. Dobrym miejscem do rozpoczęcia pracy jest Samouczek: tworzenie minimalnego interfejsu API przy użyciu platformy ASP.NET Core.

Chcesz zobaczyć kilka przykładów kodu?

Aby uzyskać pełną listę typowych scenariuszy z przykładami kodu, zobacz Krótkie omówienie interfejsów API.

Chcesz przejść prosto do pierwszego projektu?

Tworzenie minimalnej aplikacji interfejsu API za pomocą naszego samouczka: Samouczek: tworzenie minimalnego interfejsu API przy użyciu platformy ASP.NET Core.