Praktikables Softwaretesten mit Postman

Mein Praktikumsbericht

Im Rahmen meines Praktikums bei Herrn John wurde mir unter anderem das Debuggen von APIs vorgestellt. APIs, auf Deutsch auch Programmierschnittstellen, sind Funktionen einer Software die die Kommunikation zwischen mehreren unterschiedlichen Teilen eines Computersystems ermöglichen. Ihre Existenz ist unerlässlich, und somit auch, dass sie fehlerfrei funktionieren.

Um dieses fehlerfreie Funktionieren zu garantieren wurde ich von Herrn John an das Programm „Postman“ herangeführt. Dieses hilft beim Debuggen von APIs in dem man die einzelnen APIs mit Postman verbindet, die gewünschten Daten einträgt und dann sieht was die API zurückgibt. Der Haken an der Sache ist, dass das Verbinden der APIs und die anderen Vorbereitungen welche getroffen werden müssen bevor alles reibungslos funktioniert, etwas Zeit beanspruchen. Nachdem diese Vorbereitungen getroffen wurden, lässt sich per Knopfdruck der gewünschte Wert an die API schicken. Man erfährt unverzüglich und mit kaum Aufwand, ob dies auch ohne Fehler passiert ist und welche neuen Werte zurückgegeben wurden.

Als Begleitung zu diesem Debugging-Prozess hat mir Herr Johns in Swagger erstellte API-Dokumentation zu dem zu testenden Programm sehr geholfen. Swagger ist ein Werkzeug welches unter anderem ermöglicht die APIs einer Software zu dokumentieren. Das heißt, dass die APIs an sich alle aufgelistet werden, und dazu jeweils ihre Funktionen, welche Parameter sie verlangen und welche Methode sie benutzen. Eine gute und vollständige Dokumentation ist extrem wichtig, da sie anderen Programmierern wie mir ermöglicht sich in dem Programm zurechtzufinden und das Programm zu verstehen. Einen Ausschnitt einer SwaggerDoku finden Sie unten in dem Bild. Auch das Erstellen einer solche Dokumentation braucht seine Zeit und ist mit Aufwand verbunden, jedoch kann ihr fehlen auf Dauer zu erheblich höheren Aufwands- und somit Geldkosten führen. Falls es jemals vorgesehen ist das Programm zu erweitern oder auf den neusten Stand zu bringen, braucht es bei schlechter Dokumentation mehr (Arbeits-)Zeit den geschriebenen Code und die benutzten Systeme zu verstehen. Auch kann es dazu führen, dass manche Funktionen komplett neu programmiert werden müssen, da sie einfach für den Programmierer nicht verständlich sind.

David