02.b Postman
een API ontwikkelingstool die helpt bij het bouwen, testen en wijzigen van API's.
Last updated
een API ontwikkelingstool die helpt bij het bouwen, testen en wijzigen van API's.
Last updated
API's zijn essentieel voor het bouwen van software applicaties. Ze worden evenzeer voor grote als kleine projecten benut. Geschikte test- en testmethoden zijn dus ook vereist. Door API's te testen kan je fouten herkennen en tijdig elimineren. In dit deel van de cursus overlopen we het installatieproces en de basis functionaliteit van Postman.
Wat is Postman? Eenvoudig uitgelegd is Postman een API ontwikkelingstool die helpt bij het bouwen, testen en wijzigen van API's. Vrijwel alle functionaliteit die een ontwikkelaar nodig zou hebben, is ingekapseld in deze tool. Het wordt elke maand door meer dan 5 miljoen ontwikkelaars gebruikt om hun API-ontwikkeling gemakkelijk en eenvoudig te maken. Het heeft de mogelijkheid om verschillende soorten HTTP-verzoeken uit te voeren (GET, POST, PUT, PATCH) en collecties te maken voor het testen van al je API requests.
Navigeer naar "Workspaces" en klik op "My Workspace". Laten we het stapsgewijze proces bekijken voor het gebruik van Postman en de verschillende functies die Postman ons te bieden heeft voor het uittesten van API's!
New – Hier maak je een nieuwe request, collectie of environment aan.
Import – Dit wordt gebruikt om een collectie of environment te importeren.
Open New Tab – Open een nieuw tabblad voor een nieuwe request aan te maken door op deze knop te klikken.
Invite – Werk samen aan een workspace door teamleden uit te nodigen.
History - Eerdere requests die je hebt verzonden, worden weergegeven in History. Dit maakt het gemakkelijk om requests die je eerder hebt uitgevoerd te raadplegen.
Collections – Organiseer je API requests door collecties te maken. Elke collectie kan submappen en meerdere requests omvatten. Een request of map kan ook worden gedupliceerd zodat je voor nieuwe requests niet van nul moet beginnen!
Titel van een request – Hier wordt de titel weergegeven van de request waaraan je werkt. Standaard wordt "Untitled Request" weergegeven voor requests waarvoor er nog geen titel is opgegeven.
HTTP-verzoek - Als je hierop klikt, wordt een vervolgkeuzelijst weergegeven met verschillende verzoeken, zoals GET, POST, COPY, DELETE, enz. Voor deze cursus zal je alleen moeten werken met de GET methode.
Request URL - Ook bekend als een eindpunt, dit is waar je de link identificeert waar de API mee zal communiceren.
Save - Als er wijzigingen in een aanvraag zijn, is het klikken op "Save" een must, zodat nieuwe wijzigingen niet verloren gaan of worden overschreven.
Send - Door op deze knop te drukken zal je request worden uitgevoerd en zal er een antwoord worden weergeven.
Params - Hier schrijft je de parameters die nodig zijn voor een request.
Authorization – Om toegang te krijgen tot API's is de juiste autorisatie vereist. Het kan de vorm hebben van een gebruikersnaam met wachtwoord, een token, enz.
Headers - Je kan headers instellen, zoals inhoudstype JSON.
Body - Hier kan je details aanpassen voor POST requests.
Pre-request Script – Dit zijn scripts die vóór een request worden uitgevoerd.
Tests – Dit zijn scripts die tijdens een request worden uitgevoerd.
Settings - Hier kan je verschillende opties aanpassen omtrent de manier waarop de API wordt aangesproken.
GET requests worden gebruikt om informatie van de opgegeven URL op te halen. Er worden geen wijzigingen aangebracht aan het eindpunt.
We zullen de volgende URL gebruiken voor alle voorbeelden in deze Postman-zelfstudie:
Stel je HTTP-verzoek in op GET. Voer in het veld URL van de request de link in. Klik vervolgens op "Send". Je zal vanonder, in de body, een antwoord krijgen en een statuscode van 200 OK. Er zouden 5 resultaten in de body moeten staan die aangeven dat je request succesvol is uitgevoerd.
Parameters instellen is een van de handigste functies van Postman. In plaats van dezelfde requests met verschillende gegevens te maken, kan je variabelen (parameters) gebruiken. Deze gegevens kunnen afkomstig zijn uit een gegevensbestand of een omgevingsvariabele. Het gebruik van parameters helpt herhaling van dezelfde requests te voorkomen.
Parameters worden gemaakt door het gebruik van dubbele accolades: {{sample}}. Laten we eens kijken naar een voorbeeld van het gebruik van parameters:
Stap 1) Stel je HTTP-verzoek in op GET
Voer volgende link in: https://swapi.dev/api/people.
Vervang het eerste deel van de link door een parameter zoals {{url}}.
Je endpoint zou nu {{url}}/people moeten zijn.
Klik op verzenden.
Er zou geen reactie moeten zijn omdat we de bron van onze parameter niet hebben ingesteld.
Stap 2) Om de parameter te gebruiken, moet je een globale environment variabele instellen:
Klik op het oogpictogram in de rechterbovenhoek.
Klik op "Add" bij "Globals" om de variabele in te stellen op een globale omgeving die in alle collecties kan worden gebruikt.
Stap 3) Voeg je globale variabele toe.
Maak een nieuwe variabele aan genaamd url.
Stel de initial value in op de https://swapi.dev/api/.
klik op "Save".
Stap 4) Ga terug naar je GET request en klik nogmaals op "Send". Je zou nu wel een resultaat moeten terug krijgen!
Collecties spelen een belangrijke rol bij het organiseren van je API requests. Het kan worden geïmporteerd en geëxporteerd, waardoor het gemakkelijk is om collecties met een team te delen. In deze zelfstudie leer je hoe je een collectie kan aanmaken en gebruiken.
Laten we beginnen met het maken van een collectie:
Stap 1) Klik op de knop "New" in de linkerbovenhoek van de zijbalk en selecteer Collection.
Stap 2) Je hebt een nieuwe collectie aangemaakt met de naam "New Collection". Klik in de zijbalk op je nieuwe collectie en verander de naam van de collectie door op het pen icoontje te klikken in het middelste scherm zoals hieronder weergegeven. Geef je collectie de naam "Postman Test Collection".
Stap 3) Ga terug naar je vorige GET request, {{url}}/people. Klik op "Save", klik vervolgens op de naam van je nieuwe collectie en nogmaals op de knop "Save" in de rechteronderhoek van de pop-up.
Stap 4) Je Postman collectie zou nu één request moeten bevatten.
Stap 5) Maak een nieuwe request aan voor {{url}}/planets en herhaal stap 3 , zodat de collectie nu twee verzoeken bevat.
Opmerking : het kan voorkomen dat de request in Postman niet succesvol is. Dit kan te wijten zijn aan een ongeldige request URL.
Opmerking : Zorg er altijd voor dat je parameters een bron hebben zoals een omgevingsvariabele om fouten te voorkomen!
