Frank!Adapters genereren vanuit OpenAPI Specificatie

We werken aan een nieuwe Open Source aanvulling op ons Frank!Framework, namelijk de OpenApi2Frank! generator. Met deze generator kun je vanuit een OpenAPI specificatie zowel een Frank!Adapter genereren voor een consumer API als voor een producer API. 

Je kunt aansluiten op een restAPI van een andere partij, dan ben je ‘consumer’. Je kunt daarbij denken aan het ophalen van weersomstandigheden in een specifieke plaats. Nemen andere een services van jou af dan ben je de ‘producer’. Voor beide kanten kan een Frank!Adapter gegenereerd worden.

Consumer 

De nieuw ontwikkelde OpenApi2Frank! generator leest de OpenAPI specificaties uit een file of een url en genereert op basis hiervan een Frank!Adapter inclusief een complete Sender met berichtdefinities. Door een groot gedeelte automatisch te genereren, zal de Frank!Developer zijn productiviteit verbeteren.

Producer

Een tweede toepassing die we gebouwd hebben met de OpenApi2Frank! generator is het genereren van een ‘producer’ op basis van een OpenAPI specificatie. Hiermee kun je;

  1. Een bestaande API makkelijk overbouwen naar het Frank!Framework.
  2. Of je kunt om op basis van ‘design first’ aanpak eerst je API specificaties definiëren, om van daaruit met de realisatie te starten.

De OpenApi2Frank! generator leest ook hier de OpenAPI specificaties en genereert op basis hiervan een het fundament van een werkende Frank!Adapter, inclusief de berichtdefinities en een eventuele stub.

Conclusie

Je kunt de OpenApi2Frank! generator toepassen voor het consumen van een API en snel en eenvoudig de basis van een Frank!Adapter genereren. Daarnaast kun je OpenApi2Frank! toepassen bij de migratie van bestaande API’s naar het Frank!Framework met aan de buitenkant exact dezelfde API’s. En je kunt je gehele restAPI in 1 keer genereren op basis van je vooraf gedefinieerde OpenAPI specificaties.

Tot slot

Wil je de (beta) open source OpenApi2Frank! generator gebruiken om een API te consumen of te producen of wil je hier aan bijdragen, neem dan contact met ons op. De OpenApi2Frank! generator is nu nog niet publiek beschikbaar, maar we stellen deze graag gratis ter beschikking.

Vragen over deze case?
Neem contact op
Portrait of Jeroen Jansen van Rosendaal

Geschreven door
Jeroen Jansen van Rosendaal