Gedrag van mocks
Mocks bieden voornamelijk statische antwoorden op verzoeken die overeenkomen met het API-contract. Ze reageren op verzoeken zonder rekening te houden met enige beveiliging die is gedefinieerd op de API, de verzoekpayload of verzoekheaders (behalve de Accept-header die wordt gebruikt voor contentonderhandeling).
Wanneer een verzoek wordt gedaan, maakt de mock een respons aan, hetzij op basis van wat de gebruiker heeft opgegeven (voorbeeld, standaardwaarde, enum-waarde), hetzij met behulp van een ingebouwde voorbeeldwaarde.
Als het verzoek bijvoorbeeld een object retourneert, wordt het voorbeeld van het object gebruikt als er een is opgegeven. Zo niet, dan worden de voorbeelden van elk van de eigenschappen gebruikt en wordt daaruit een JSON-object gemaakt. Dit werkt ook voor responsheaders.
Responsen
- Als uw bewerking alleen een responsbereik heeft, wordt de eerste status in het bereik geretourneerd. Een bewerking met een 2XX-responsgebied retourneert bijvoorbeeld een 200-respons.
- Als uw bewerking een specifieke responscode en responsbereiken of een standaardrespons heeft, wordt de gedefinieerde code geretourneerd. Een bewerking met een 201-respons en een 3XX-responsgebied retourneert bijvoorbeeld de 201-respons.
- Als uw bewerking meerdere responsbereiken heeft en geen gedefinieerde responsstatus, wordt de eerste status van het eerste bereik geretourneerd. Een bewerking met een 4XX- en een 5XX-responsgebied retourneert bijvoorbeeld een 400-respons.
- Als uw bewerking alleen een standaardrespons heeft, is de geretourneerde respons afhankelijk van de bewerkingsmethode:
- Als de gebruikte methode POST is, wordt een 201-respons geretourneerd.
- Voor andere methoden wordt een 204-respons geretourneerd als er geen responsbody is gedefinieerd en wordt een 200-respons geretourneerd als er wel een responsbody is gedefinieerd.
- Als uw bewerking geen gedefinieerde respons heeft, wordt een 200-respons geretourneerd.
- 1XX-responsen worden niet ondersteund door mocks. Als een bewerking het 1XX-responsgebied of een gedefinieerde responscode in dit bereik heeft, wordt een 404-respons geretourneerd.
Combinaties
- All of: als er een voorbeeld is gedefinieerd, wordt dit geretourneerd. Als er geen voorbeeld is gedefinieerd voor het gegevenstype, worden de eigenschappen van de typen samengevoegd en worden de voorbeelden gebruikt die op eigenschapsniveau zijn gedefinieerd, of worden er voorbeeldwaarden gegenereerd. Als een eigenschap twee keer is gedefinieerd in verschillende typen, blijft alleen de laatste waarde behouden. Primitieve typen worden genegeerd, alleen objecten worden geretourneerd.
- Any of of One of: als er een voorbeeld is gedefinieerd, wordt dit geretourneerd. Als er geen voorbeeld is gedefinieerd, wordt er een respons gegenereerd op basis van het eerste type in de lijst.
Beperkingen
- Available in request only: de eigenschap is uitgesloten van het gegenereerde voorbeeld.
- Available in response only: de eigenschap is opgenomen in het gegenereerde voorbeeld.
- Available in request and response: de eigenschap is opgenomen in het gegenereerde voorbeeld.
Voorbeelden die op het niveau van het gegevenstype worden verstrekt, hebben voorrang op eigenschappen. Als een eigenschap die is gedefinieerd als Available in request only is opgenomen in het voorbeeld, wordt deze geretourneerd in de respons. Als een eigenschap die is gedefinieerd als Available in response only of Available in request and response niet is opgenomen in het voorbeeld, wordt deze niet geretourneerd in de respons.