Responsgeneratie met API-mocks
API-mocks reageren zo realistisch mogelijk op alle aanroepen die ze ontvangen. Bij het genereren van een responsbody geeft een mock prioriteit aan door de gebruiker verstrekte gegevens door te zoeken naar een voorbeeldveld, vervolgens een standaardwaarde en daarna een enum-veld. Als er een wordt gevonden, wordt deze als voorbeeld gebruikt, anders wordt er een JSON-voorbeeld gegenereerd op basis van het gegevenstype dat wordt geretourneerd door de bewerking die wordt aangeroepen.
Neem als voorbeeld de onderstaande definitie van het gegevenstype Company. Deze bevat geen door de gebruiker verstrekte voorbeelden.
Wanneer mocking is geactiveerd, retourneert een GET-aanroep naar de resource /company/{companyId} een automatisch gegenereerde JSON-respons op basis van de structuur van het gegevenstype.
De mock heeft een aantal interessante dingen gedaan, waaronder het genereren van waarden voor aangepaste responsheaders (bijv. x-my-custom-header), het identificeren van arrays en het maken van geschikte voorbeelden (bijv. de eigenschap tags), en ook het identificeren van geneste structuren en het genereren van waarden daarvoor (bijv. de eigenschap address).
API Designer-mocks ondersteunen content negotiation, dus u kunt de Accept-requestheader gebruiken om te selecteren welke body moet worden geretourneerd uit verschillende opties (die elk mogelijk een eigen voorbeeld hebben), waardoor de voorbeelden die door de mock worden geretourneerd, veranderen.