WebAPI testen mit .http Files

WebAPI testen mit .http Files

- Matt

Mit der neuesten Visual Studio 2022 Version 17.5 ist es nun möglich, WebAPIs direkt innerhalb der Entwicklungsumgebung mit .http-Dateien zu testen. Diese neue Funktion bietet Entwicklern eine einfache und effiziente Möglichkeit, API-Endpunkte zu testen, ohne auf externe Tools angewiesen zu sein.

Vorteile der Nutzung von .http Files

  1. Einfache Syntax: .http-Dateien nutzen eine einfache und leicht verständliche Syntax zur Definition von HTTP-Anfragen.
  2. Integrierte Umgebung: Die Tests können direkt in Visual Studio durchgeführt werden, was den Workflow vereinfacht und beschleunigt.
  3. Automatisierte Tests: Mit .http-Dateien können automatisierte Tests erstellt und leicht wiederholt werden.

Beispiel einer .http Datei

Hier ist ein einfaches Beispiel, wie eine .http-Datei aussehen könnte, um eine GET-Anfrage an eine WebAPI zu senden:

GET https://api.example.com/items
Accept: application/json

Und hier ein Beispiel für eine POST-Anfrage mit einem JSON-Body:

POST https://api.example.com/items
Content-Type: application/json

{
    "name": "NewItem",
    "price": 19.99
}

Verwendung in Visual Studio

Um .http-Dateien in Visual Studio zu nutzen, folge diesen Schritten:

  1. Datei erstellen: Erstelle eine neue Datei mit der Endung .http im Projektverzeichnis.
  2. Anfragen definieren: Schreibe die gewünschten HTTP-Anfragen in die .http-Datei.
  3. Anfragen ausführen: Klicke auf die Schaltfläche “Run Request” neben der Anfrage in Visual Studio, um sie auszuführen.

Visual Studio zeigt die Antwort der API direkt im Editor an, was die Überprüfung und Fehlersuche erleichtert.

Fazit

Mit .http-Dateien bleibt das Ausprobieren der eigenen API in der IDE, statt in einem zweiten Werkzeug daneben. Die Datei liegt im Projekt und wandert damit auch in die Versionsverwaltung.

Für weitere Informationen und eine detaillierte Anleitung besuche den Link zur Quelle.