Inspector Gadget

API generated debugger interface voor Philips Hue

Voor de Api van Philips Hue is momenteel geen goede developer ervaring. De documentatie is niet gemakkelijk te volgen en er mist een hoop informatie. Ook is er geen makkelijke manier om met de Api te testen.
Hiervoor ging ik samen met een mede stagair een applicatie maken die deze developer ervaring moest verbeteren.
Concept
Ik ging een tool maken die een interactieve documentatie genereert van de Api. hiervoor wordt een RAML bestand uitgelezen waarvan vervolgens een interface wordt gemaakt die een developer kan gebuiken om de Api te testen en te ontdekken.
Het mooie van dit systeem is dat de tool zelf niet aangepast hoeft te worden als de Api veranderd. De tool wordt namelijk gegenereerd van een structuur bestand van de Api.
De tool genereerd ook gelijk de documentatie waardoor een developer alle mogelijke Api eindpunten kan zien, testen en lezen welke variabelen er verwacht worden. Er zit ook overal autocompletion op die ook gebouwd wordt vanuit de RAML specificatie.

Features

Documentatie gegenereerd vanuit Api specificatie
Debugger gegenereerd vanuit Api specificatie
Autocompletion gegenereerd vanuit Api specificatie

OPDRACHTGEVER
PROGRAMMEER TAAL
PROJECT DUUR
PROGRAMMAS
PLATFORM

Q42 | Philips | Signify
HTML | CSS | Typescript
8 weken
-
Hue Api