Als u niet bekend bent met Multi-step API’s, raden we u aan de artikelen Multi-step API-monitoring en Multi-step API Response te lezen voor een overzicht van hun belangrijkste functies en features.
Dit artikel biedt informatie over hoe het maximale aantal pogingen werkt en hoe ze helpen bij het verifiëren van API-responses en het verzekeren van verwacht gedrag.
Maximaal aantal pogingen
Er zijn situaties waarin een API-request mogelijk extra tijd nodig heeft om het proces te voltooien voordat een succesvolle response wordt geretourneerd. Bij het uploaden van een bestand bijvoorbeeld, kan de API in eerste instantie reageren met {"result":"processing"} in de JSON-body om aan te geven dat het proces nog aan de gang is. Zodra de verwerking is voltooid, retourneert de API {"result":"success"}. In dergelijke scenario’s kunt u de controleregel configureren om de API te blijven peilen totdat deze een success-response retourneert.
Er zijn ook momenten waarop uw API’s onverwacht gedrag kunnen vertonen vanwege onvoorziene omstandigheden of externe problemen zoals downtime en connectiviteit. Deze situaties worden niet als fouten beschouwd, het probleem kan mogelijk worden opgelost door de stappen gewoon opnieuw te proberen.
Met Maximaal aantal pogingen kan de controleregel de stap met regelmatige tussenpozen blijven controleren totdat het gewenste resultaat is bereikt of de limiet voor het aantal pogingen is bereikt. Door deze optie in te schakelen, geeft u de controleregel de opdracht de stap opnieuw te proberen als een of meer assertions mislukken. U kunt maximaal 50 nieuwe pogingen instellen, met een minimum van twee, aangezien de eerste request al als de eerste poging telt.
U kunt ook een wachttijd tussen pogingen opgeven om de vertraging te bepalen tussen de uitvoering van de vorige poging en de volgende. Deze moet worden ingesteld tussen 500 ms en 30.000 ms, met een standaardduur van 1.000 ms.
Nadat u de optie voor een stap heeft ingeschakeld, probeert de controleregel de stap opnieuw totdat ofwel het maximale aantal pogingen is bereikt of elke assertion slaagt. Vanaf dat moment gaat de controleregel gewoon door en voert de rest van de stappen in volgorde uit. Als het maximale aantal pogingen is bereikt en er nog steeds minstens één assertion mislukt, meldt de controleregel een fout in de controleregel log.