Mockování

Možnost mockovat patří mezi nejzásadnější výhody OAS. V principu mockování funguje tak, že vybraný nástroj spustit fake webový server, který zpřístupní veškeré endpointy popsané v API. Jako výchozí hodnoty pak použije tzv. examples.

V praxi umožňuje OAS vytvářet examples na úrovni vlastností, komponent a endpointů. Při návrhu specifikace doporučuji být důsledný a tyto examples uvádět. Když příklady chybí, kvalita mock serveru rapidně klesá. Porovnejte následující příklady:

Vrácená struktura bez examples

Následující příklad je krutá realita většiny dokumentací. Koneckonců se můžete podívat třeba na dokumentaci k API Telma.