Net als bij reguliere AFD-definities bevindt de output van een OpenAPI Description zich in een zip-container.
Op het eerste niveau binnen de zip-container bevindt zich een YAML-file (openapi.yaml) waarin de OpenAPI Description staat beschreven. In de YAML wordt (indien gekoppeld) verwezen naar bijgesloten AFD-functies in de vorm van AFD-definities die zich in folders op het eerste niveau van de zip-container bevinden. In het onderstaande voorbeeld zijn dat ‘nieuwePolis_aanroep’ en ‘nieuwePolis_resultaat’.
Voorbeeld van inhoud OAD zip-container
Voorbeeld van het onderdeel ‘components’ in de YAML met verwijzing naar bijgesloten functie AFD-definitie
Valideren van OAD’s
Voor het valideren van OAD’s zijn verschillende tools beschikbaar. Door middel van een extensie in Visual Studio Code is het mogelijk om dit zonder kosten uit te voeren. Wij raden hiervoor de extensie “OpenAPI (Swagger) Editor” aan.
VS Code extensie OpenAPI (Swagger) Editor