Insomnia Rest Client ist ein nützliches Tool, um APIs zu testen, sich wichtige Routen zu speichern und diese dann abfragen zu können. Folgendes Szenario: Wir programmieren für einen Kunden ein Interface und sollen mit der HelloCodeAPI arbeiten. Leider hat der Kunde nur eine sehr alte Dokumentation für uns, die nicht mehr so gut nachvollziehbar ist, sodass wir nicht sofort loslegen können. Was können wir also tun? Die Antwort: Wir müssen uns durchtesten, bis wir die Route finden, die wir nutzen können, um uns die User auszugeben. Höchstwahrscheinlich müssen wir also verschiedene Routen mit einem API KEY testen.
Rest bezeichnet eine moderne Variante für die Architektur von APIs, die bestimmte Prinzipien beachten soll. Keine Anfragen sollen voneinander abhängig sein. Es darf also keine andere Request/Query notwendig sein, um ein erfolgreiches Ergebnis von der API zu erhalten. Das Client-Server-Verhältnis sollte beachtet werden, was bedeutet, dass der Server uns einen Dienst zur Verfügung stellt, den wir bei Bedarf als Client nutzen können. Die Schnittstellen müssen einheitlich sein, entsprechend darf die Ausgabe der Daten für keinen bestimmten Dienst angepasst sein und muss für alle gleichermaßen genutzt werden.
Für genaue Details ist der sehr ausführliche Wikipedia Artikel zum Thema zu empfehlen.
Client bezeichnet den Nutzer, der auf den Server zugreift.
Nun haben wir unsern Request für User geschrieben. Falls wir jetzt aber die URL noch einmal ändern wollen, ist das auch kein Problem. Unser API KEY bleibt eingetragen, sodass wir nicht jedes Mal die URL auseinandernehmen und wieder richtig zusammensetzen müssen.
Nun können wir aber auch zwischen den verschiedenen Request Methoden wählen
Die Möglichkeiten von Insomnia sind praktisch, um alle API Routen auch über verschiedene Methoden schnell und einfach testen können. Das funktioniert im Browser leider nicht mehr so einfach - zumindest nicht ohne größeren Aufwand.
Natürlich können wir auch verschiedene Authentications & Body Types auswählen. Eigene Headers können natürlich auch mitgesendet werden.
Mit dem Insomnia Rest Client können wir uns auch ein Beispiel-Request erzeugen lassen. In den unteren Bildern könnt ihr sehen, wie ihr dort hingelangt. Unter anderem könnt ihr euch folgende Sprachen ausgeben lassen:
Diese Möglichkeit den Code zu erzeugen ist vor allem für Anfänger praktisch, die noch nicht wissen, wie die gängigen Verfahren in den verschiedenen Programmiersprachen ablaufen.
In Insomnia kann man auch Variablen wiederholen, was für größere APIs im Test-Modus ziemlich nützlich ist.
Oben rechts auf No Environment klicken
Unter Manage Environment können neue Environments angelegt werden und bestehende durch neue Variable ergänzt werden. Die neue Variable entsteht dann im JSON Format. In diesem Beispiel wurde die Variable “URL” angelegt.
Nun können wir an beliebigen Stellen auf die Variable zugreifen.
So kannst auch du ganz einfach Variablen in Insomnia nutzen.
Zu beachten ist, dass es auch noch weitaus mächtigere Alternativen, wie zum Beispiel “Postman”, gibt. Allerdings ist diese Alternative etwas für den Profi, da man dort deutlich umfassendere Möglichkeiten hat, die für den Alltag in der Arbeit mit APIs nicht notwendig sind.
Welche Client Software bevorzugst du fürs Testen von API Request?
Hinterlasse mir gerne einen Kommentar zum Artikel und wie er dir weitergeholfen hat beziehungsweise, was dir helfen würde das Thema besser zu verstehen. Oder hast du einen Fehler entdeckt, den ich korrigieren sollte? Schreibe mir auch dazu gerne ein Feedback!
Es sind noch keine Kommentare vorhanden? Sei der/die Erste und verfasse einen Kommentar zum Artikel "Insomnia Rest Client für API Calls Richtig Einsetzen"!
