Documentatie

De specificatie van de 1.0 versie van de Open Onderwijs API is te vinden op: 230316 Open Onderwijs API version 1.0 web (in PDF en Engelstalig).

Er is ook online documentatie te vinden via de URL http://api.openonderwijsapi.nl/v1/docs.  Hiervoor is een ander API framework gebruikt, Swagger, wat in feite ook een interface biedt op je API, maar wat wij hier vooral gebruiken als documentatie interface.

Je ziet als eerste een overzicht van de diverse Open Onderwijs API mogelijkheden:

Swagger-OOA

Je kunt op ieder van de getoonde items klikken om te zien welke gebruiks mogelijkheden er mogelijk zijn. Bijvoorbeeld de optie /persons kent de volgende opties:Swagger-operations-persons

Van ieder van de getoonde opties is vervolgens te zien welke response er gegenereerd wordt. Vergelijkbaar met de referentie-implementatie zie je hier de JSON output format verschijnen als je de ‘Try it out!’ button gebruikt.

Swagger-persons-tryout