RestSharp für C# (.NET): Vollständige Anleitung mit Beispielen

Was ist RestSharp und warum wird es benötigt?

RestSharp ist eine beliebte Open-Source-Bibliothek für C# (.NET), die entwickelt wurde, um die Arbeit mit RESTful-APIs zu vereinfachen. Sie bietet eine komfortable und intuitive Oberfläche zum Ausführen von HTTP-Anfragen (GET, POST, PUT, DELETE, PATCH u.a.) und zur Verarbeitung von Antworten von Webservices.

RestSharp löst mehrere zentrale Aufgaben:

• Code-Vereinfachung: Anstatt umfangreichen Code mit HttpClient zu schreiben, bietet RestSharp eine prägnante Fluent-Schnittstelle.
• Automatische Serialisierung/Deserialisierung: Die Bibliothek konvertiert Ihre C#-Objekte automatisch in JSON/XML und zurück, wodurch manuelle Arbeit entfällt.
• Komfortable Fehlerbehandlung: RestSharp stellt verständliche Klassen zur Verarbeitung von HTTP-Statuscodes und Ausnahmen bereit.
• Authentifizierungsunterstützung: Integrierte Unterstützung für OAuth, Basic Auth, JWT und andere Verfahren.
• Dateiverwaltung: Einfaches Hoch- und Herunterladen von Dateien.

Die Bibliothek wird aktiv in .NET-Anwendungen (ASP.NET Core, Konsolenanwendungen, Xamarin, Unity) für die Integration mit externen Diensten wie sozialen Netzwerken, Zahlungssystemen, Cloud-Plattformen usw. eingesetzt.

Installation von RestSharp

RestSharp wird über den NuGet-Paketmanager installiert. Wählen Sie eine der folgenden Methoden:

Über die Package Manager Console (Visual Studio):

Install-Package RestSharp

Über die .NET CLI (Kommandozeile):

dotnet add package RestSharp

Über die NuGet-Oberfläche (Visual Studio/Rider):

Öffnen Sie Manage NuGet Packages → suchen Sie nach RestSharp → installieren Sie die neueste stabile Version.

Fügen Sie nach der Installation die using-Direktive in Ihren Code ein:

using RestSharp;

Schnellstart: Erste Anfrage

Lassen Sie uns eine einfache GET-Anfrage an eine öffentliche API (JSONPlaceholder) stellen und eine Liste der Benutzer abrufen.

using RestSharp;

var client = new RestClient("https://jsonplaceholder.typicode.com");
var request = new RestRequest("/users", Method.Get);

var response = client.Execute(request);

if (response.IsSuccessful)
{
    Console.WriteLine(response.Content); // Gibt den JSON-String aus
}
else
{
    Console.WriteLine($"Fehler: {response.StatusCode} - {response.ErrorMessage}");
}

Dieser Code erstellt einen Client, formuliert eine GET-Anfrage an den Endpunkt /users und gibt die Antwort in der Konsole aus. Beachten Sie: response.IsSuccessful prüft, ob der Antwortstatus im Bereich 200-299 liegt.

Wichtige Methoden und Funktionen von RestSharp

Im Folgenden werden die wichtigsten Methoden der Bibliothek mit Beschreibung, Parametern und Beispielen vorgestellt.

1. RestClient(string baseUrl) — Client-Konstruktor

Beschreibung: Erstellt eine Instanz des HTTP-Clients mit einer Basis-URL. Alle nachfolgenden Anfragen verwenden diese URL als Grundlage.

Parameter:

• baseUrl (string) — Die Basisadresse der API (z. B. "https://api.example.com").

Beispiel:

var client = new RestClient("https://api.github.com");

2. RestRequest(string resource, Method method) — Anfrage erstellen

Beschreibung: Formuliert eine HTTP-Anfrage an die angegebene Ressource mit der gewünschten Methode (GET, POST, PUT, DELETE usw.).

Parameter:

• resource (string) — Der relative Pfad zur Ressource (z. B. "/users").
• method (Method) — Die HTTP-Methode aus der Enumeration Method (Get, Post, Put, Delete, Patch, Head, Options).

Beispiel:

var request = new RestRequest("/users/1", Method.Get);

3. client.Execute(IRe