Maak een OpenAPI specificatie
Een OpenAPI Specificatie (OAS) is een YAML of JSON bestand met de eigenschappen van de data die een REST API als input accepteert en als output teruggeeft. Een OpenAPI Specificatie beschrijft niet hoe een API geïmplementeerd is, en heeft dus geen binding met specifieke programmeertalen.
De voordelen
Een OpenAPI Specificatie is nuttig voor ontwikkelaars en gebruikers van een API:
- Voor ontwikkelaars versnelt de OpenAPI Specificatie het ontwikkelproces: de OpenAPI Specificatie kan een API worden ontworpen voordat deze wordt geprogrammeerd, kunnen niet-developers bijdragen aan het ontwerp van een API, en biedt developers duidelijke eisen voor het programmeren van een API.
- Voor gebruikers dient de OpenAPI Specificatie als documentatie, en een complete en duidelijke documentatie is belangrijk voor het succesvol en eenvoudig gebruik van een API. En omdat de OpenAPI Specificatie gebruikt wordt voor zowel het programmeren als het gebruik van een API, garandeer je dat de API precies werkt als beschreven in de documentatie.
Makkelijk genereren met de OAS Generator
Om het maken van een OAS Specificatie makkelijker te maken hebben wij de OAS Generator gebouwd. Met deze tool creëer je gemakkelijk een lijstje met resources; de tool genereert automatisch de benodigde endpoints voor je.