Hoe API's te debuggen met Postman

Inhoudsopgave:

Hoe API's te debuggen met Postman
Hoe API's te debuggen met Postman
Anonim

Postman is een programma en toolkit die het werken met, ontwikkelen en debuggen van externe API-services eenvoudiger maakt. Het biedt een platform voor het maken, beheren en werken met GET- en POST-verzoeken.

Wat is postbode?

Postman beschrijft zichzelf als een "Platform voor API-ontwikkeling". Op het meest basale niveau biedt het een eenvoudige GUI-interface voor interactie met externe API's. Het is in wezen een ultramoderne REST-client, ontworpen voor het werken met complexe API's.

Afbeelding
Afbeelding

Het is niet alleen een geweldige REST-client, maar biedt ook tools voor het beheren van verzamelingen verzoeken. Met behulp van deze collecties en kennis van het API-schema kan het volledig geautomatiseerde API-tests uitvoeren, die kunnen worden geïntegreerd in CI/CD-pijplijnen om ervoor te zorgen dat eventuele codewijzigingen de API in productie niet verbreken.

Postbode gebruiken

Om te beginnen, testen we een basisverzoek. U kunt meerdere verzoeken opslaan in Collecties, die opnieuw kunnen worden gebruikt en gedeeld.

In Postman heeft elk verzoek zijn eigen tabblad in de werkruimte. U vindt bedieningselementen voor de verzoekinstellingen, evenals uitvoer van de server. Als je het op volledig scherm gebruikt, kun je het wisselen naar de kolommodus naast elkaar met de knop rechtsonder.

Afbeelding
Afbeelding

U kunt het verzoektype wijzigen via de vervolgkeuzelijst op de URL-balk. De meest gebruikelijke methoden zijn GET en POST, maar alle HTTP-werkwoorden worden volledig ondersteund.

Afbeelding
Afbeelding

Onder het tabblad "Authenticatie" moet u de verificatiesleutels instellen voor de API die u gebruikt, tenzij deze openbaar is. Postman ondersteunt OAuth 1 en 2, evenals de meeste andere tokentypes naast Basic Auth.

Afbeelding
Afbeelding

Onder 'Headers' kunt u de koppen van het bericht instellen, zoals Content-Type. Veel hiervan worden automatisch ingesteld, wat u kunt bekijken onder de knop "Verborgen".

Afbeelding
Afbeelding

Voor de hoofdtekst van het verzoek kunt u formuliergegevens specificeren met behulp van sleutel-waardeparen, een binair pakket, een GraphQL-verzoek verzenden of gewoon onbewerkte JSON- of tekstgegevens verzenden. De editor bevat een ingebouwde JSON-editor en validator.

Afbeelding
Afbeelding

Een van de coolste dingen die je met Postman kunt doen, is het opzetten van API-tests - deze zijn gecodeerd in JavaScript en worden uitgevoerd nadat het resultaat is ontvangen. U kunt meer lezen over het instellen ervan in de handleiding van Postman over het gebruik ervan

Afbeelding
Afbeelding

Zodra je je verzoek hebt voorbereid, kun je het testen met de knop "Verzenden". U zou een reactie moeten krijgen van de externe server, die u kunt bekijken in Pretty-print, HTML-preview of gewoon onbewerkte uitvoer. U kunt verschillende statistieken zien, zoals de HTML-responscode, payload-grootte en ping, in de statusbalk boven de

Afbeelding
Afbeelding

U kunt ook de vervolgkeuzelijst wijzigen van "Body" naar "Header" om de headers te bekijken die de API heeft geretourneerd.

Met de JavaScript-testers kunt u ook eenvoudige gegevensvisualisaties maken, zoals taart- en staafdiagrammen, die handig kunnen zijn om veel gegevens te begrijpen.

Afbeelding
Afbeelding

Als je erop terug wilt komen, of de test wilt opslaan, kun je deze opslaan in een 'Verzameling'. U kunt dan de Collection Runner in de bovenste menubalk gebruiken om alle verzoeken en tests in de verzameling uit te voeren, die kunnen worden gebruikt om alle API-eindpunten te testen.

Populair onderwerp