Wat is Swagger?

Swagger is een framework voor API's.
Door Swagger (http://swagger.io) te gebruiken kunnen uw API's eenvoudig gebruikt worden door diverse clients.

Hoe is Swagger ontstaan?

Bij het bouwen van een interface, kunnen we de bijbehorende documentatie onderhouden of het (laten) genereren door bepaalde tools vanuit onze code. Het nadeel is dat we dit handmatig (of semi-automatisch) moeten beheren en dat het niet door andere software is te lezen.

Een andere benadering is WADL te gebruiken, dat door bepaalde tools kan worden gegenereerd. In dit geval kan het door software worden gelezen, maar niet door mensen. Daarnaast is dit een nogal vervelend proces.

Bij het zoeken naar een eenvoudiger oplossing is Swagger ontstaan.
Swagger is een specificatie voor het beschrijven van REST API's. Het formaat kan niet alleen door de mens maar ook door software worden gelezen.

In de laatste versie, Swagger 2.0, is het formaat in zowel JSON alsook YAML beschikbaar.

Swagger en Adelia Studio

De WS_CONFIGURE instructie in Adelia Studio bevat vanaf versie 13 ptf05 attributen om de documentatie van de REST Web service beschikbaar te maken in Swagger.