Einführung in die .NET Core Minimal API

Mit der Veröffentlichung von .NET 6 führte Microsoft die Minimal API-Funktion ein, die Entwicklern die Möglichkeit bietet, APIs schneller und mit weniger Boilerplate-Code zu entwickeln. Die Minimal API wurde als Alternative zur etablierten ASP.NET Core MVC-Architektur entwickelt und ist speziell für kleinere, einfache APIs gedacht, bei denen Geschwindigkeit und Einfachheit im Vordergrund stehen.

Durch eine vereinfachte Struktur und den Einsatz weniger Konfigurationsdateien wird die Einstiegshürde für neue Entwickler gesenkt. In diesem Artikel werfen wir einen Blick auf die Vorteile, die Funktionsweise und ein Beispiel zur Implementierung einer Minimal API in .NET Core.

Vorteile der Minimal API

Die Minimal API bietet einige signifikante Vorteile:

• Einfache Syntax: Minimal APIs benötigen keine umfassenden Konfigurationsdateien oder Klassenstrukturen wie Controller und Middleware. Dies reduziert den Code-Overhead erheblich.
• Schnellere Entwicklung: Da weniger Code geschrieben werden muss, ist die Entwicklung schneller. Außerdem sind Minimal APIs besonders für kleine oder experimentelle Projekte geeignet.
• Performance: Durch die vereinfachte Architektur kann die Minimal API schneller sein, insbesondere bei geringen Anforderungen an komplexe Funktionen.
• Leichter Einstieg: Für Entwickler, die neu in .NET sind oder schnell ein REST-API aufsetzen möchten, sind Minimal APIs eine unkomplizierte Lösung.
• Einfache Wartung: Da der Code auf das Wesentliche reduziert ist, wird auch die Wartung des Projekts einfacher und schneller.

Nachteile der Minimal API

Obwohl die Minimal API von .NET Core eine hervorragende Möglichkeit für den schnellen Aufbau einfacher APIs bietet, bringt sie einige Einschränkungen und Nachteile mit sich, insbesondere für größere und komplexere Projekte. Im Folgenden sind die Hauptnachteile aufgeführt:

Begrenzte Struktur und Skalierbarkeit:

• Minimal APIs verzichten auf die klassische Struktur mit Controllern und Service-Schichten, was bei kleineren Projekten ein Vorteil sein kann. Bei größeren Anwendungen kann jedoch der Überblick verloren gehen, wenn die Anzahl der Endpunkte wächst.
• Die Struktur wird schnell unübersichtlich, da alle Endpunkte oft in einer einzigen Datei (meist Program.cs) definiert werden. Für Projekte, die über eine handvoll Endpunkte hinausgehen, kann dies problematisch sein.

Fehlende Trennung von Verantwortlichkeiten:

• In komplexen Architekturen wird üblicherweise die Separation of Concerns (SoC) durch den Einsatz von Controllern, Services und Repositories sichergestellt. Minimal APIs fördern jedoch eine in-line Definition von Endpunkten, was die Trennung der Logik erschwert und möglicherweise zu „spaghetti code“ führt.
• Ohne klar definierte Controller- und Service-Schichten wird der Code schwieriger zu testen und zu warten.

Eingeschränkte Funktionalität bei Validierungen und Filtern:

• Im Gegensatz zu ASP.NET Core MVC gibt es weniger integrierte Möglichkeiten für die Validierung von Modellen und die Nutzung von Filtern (wie z. B. Action- oder Authorization-Filtern). Dies erfordert entweder zusätzliche manuelle Validierung oder die Nutzung externer Bibliotheken.
• Zwar lassen sich Validierungen auch in Minimal APIs implementieren, jedoch fehlt die Integration für eine saubere Modellvalidierung, wie sie z.B. durch DataAnnotations in ASP.NET MVC geboten wird.

Begrenzte Middleware-Integration:

• Minimal APIs unterstützen zwar Middleware-Komponenten, jedoch ist die Kontrolle und Anpassung eingeschränkter. Bei spezifischen Anforderungen, die eine komplexe Middleware-Kette benötigen, kann dies problematisch sein.
• Insbesondere bei APIs, die eine sehr differenzierte Behandlung der Anfragen benötigen (z. B. verschiedene Middleware-Schichten für Authentifizierung, Logging oder Caching), ist die Minimal API oft nicht flexibel genug.

Eingeschränkte Unterstützung für Versionierung:

• Die API-Versionierung ist ein oft benötigtes Feature bei umfangreichen Web-APIs, vor allem in produktiven Umgebungen. Die Minimal API bietet hier keine integrierte Lösung, was für größere und langfristige Projekte ein Nachteil sein kann.
• In ASP.NET Core MVC ist die Versionierung deutlich besser unterstützt und leichter zu konfigurieren.

Schwierigere Testbarkeit:

• Da Minimal APIs Endpunkte inline definieren, wird es schwieriger, einzelne Komponenten separat zu testen. Eine klare Trennung der Verantwortlichkeiten und Testbarkeit auf Unit-Level ist weniger gegeben.
• In der Regel müssen zusätzliche Anpassungen vorgenommen werden, um Unit Tests oder Integrationstests effektiv durchführen zu können, was bei klassischen MVC-Controllern einfacher ist.

Geringere Unterstützung für Authentifizierung und Autorisierung:

• Die Integration und Steuerung von Authentifizierungs- und Autorisierungsmechanismen ist bei Minimal APIs zwar möglich, jedoch fehlen einige der feineren Kontrollmöglichkeiten und Anpassungsoptionen, die in einer klassischen ASP.NET Core MVC-Anwendung zur Verfügung stehen.
• Für APIs mit komplexen Sicherheitsanforderungen und differenzierter Zugriffssteuerung kann es daher notwendig sein, eine vollwertige MVC-Struktur zu verwenden.

Aufbau einer Minimal API

Eine Minimal API konzentriert sich darauf, so wenig wie möglich zu definieren und trotzdem die volle Funktionalität bereitzustellen. Hier ist ein Grundgerüst für eine Minimal API in .NET 6:

1. Minimal API im Code umsetzen

Eine Minimal API besteht im Wesentlichen nur aus der Program.cs-Datei. Hier ein einfaches Beispiel, das die grundlegenden Funktionen einer Minimal API zeigt:

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

// Beispiel für eine einfache GET-Anfrage
app.MapGet("/", () => "Willkommen bei der Minimal API!");

// Beispiel für einen GET-Endpunkt mit Parameter
app.MapGet("/user/{id}", (int id) =>
{
    return Results.Ok(new { Id = id, Name = "Benutzer" + id });
});

// Beispiel für einen POST-Endpunkt
app.MapPost("/user", (User user) =>
{
    return Results.Created($"/user/{user.Id}", user);
});

app.Run();

// Klasse für den Benutzer, die beim POST-Endpunkt verwendet wird
public record User(int Id, string Name);

Nun können Sie die API unter http://localhost:5000 (oder http://localhost:5001 für HTTPS) aufrufen.

Erläuterung des Codes

• MapGet und MapPost sind vereinfachte Methoden, um Endpunkte für GET- und POST-Anfragen zu erstellen.
• Results.Ok und Results.Created werden verwendet, um eine standardisierte HTTP-Antwort zu erstellen.
• Durch die Verwendung eines record für die Klasse User wird der Code für Datenstrukturen vereinfacht.

2. API-Endpunkte testen

• Rufen Sie die Startseite auf: GET / → Antwort: "Willkommen bei der Minimal API!"
• Rufen Sie einen Benutzer auf: GET /user/1 → Antwort: { "Id": 1, "Name": "Benutzer1" }
• Erstellen Sie einen neuen Benutzer: POST /user mit einem JSON-Body { "Id": 2, "Name": "Benutzer2" }

Erweiterte Funktionen der Minimal API

Die Minimal API unterstützt eine Vielzahl von Funktionen, die auch in komplexeren APIs verfügbar sind:

• Dependency Injection: Sie können Services mithilfe von builder.Services.AddScoped() registrieren und verwenden.
• Middleware: Wie in ASP.NET Core können Middleware-Komponenten eingebunden werden.
• Validierung und Datenbindung: Parameter und Body-Inhalte können automatisch validiert und gebunden werden.
• Authentifizierung und Autorisierung: Minimal APIs unterstützen die Integration von Authentifizierungs- und Autorisierungsmechanismen.

Beispiel für Dependency Injection in einer Minimal API

builder.Services.AddScoped<IMyService, MyService>();

app.MapGet("/service", (IMyService service) =>
{
    return service.GetData();
});

In diesem Beispiel wird ein MyService über Dependency Injection eingebunden und kann in der API verwendet werden.

Wann ist die Minimal API sinnvoll?

Die Minimal API ist optimal geeignet für:

• Mikroservices: Bei kleinen, unabhängigen Services können Minimal APIs sehr effektiv sein.
• Prototypen und Tests: Für Prototypen, Proof-of-Concepts und einfache Anwendungen ist die Minimal API ideal.
• Einfache APIs ohne komplexe Logik: Bei APIs, die wenige Endpunkte und eine geringe Logik haben, kann die Minimal API die Komplexität stark reduzieren.

Fazit

Die Minimal API in .NET Core bietet eine einfache Möglichkeit, um schnell und effizient APIs zu entwickeln. Mit der Reduzierung auf das Wesentliche können kleine und effiziente APIs ohne den üblichen Overhead einer vollständigen ASP.NET Core MVC-Anwendung erstellt werden. Dies macht sie zu einer idealen Wahl für einfache Anwendungen und Mikroservices.

Die Minimal API ist dabei kein Ersatz für die bewährte ASP.NET Core MVC-Architektur, sondern vielmehr eine Ergänzung, die Entwicklern mehr Flexibilität gibt, um Projekte je nach Komplexität und Umfang schnell und effizient umzusetzen.