Kapitel 13. Die Remote API

Inhaltsverzeichnis

13.1. Überblick
13.2. REST-Clients
13.3. Dokumentation

13.1. Überblick

Über eine REST-basierte Schnittstelle können Daten wie Testfälle, Ergebnisse oder Informationen über Benutzer entweder im XML- oder im JSON-Format abgerufen werden. Die API ist über die URL http://{host}:{port}/klaros-web/api/v1/resources/ erreichbar.

JSON-Ausgabe nach der Suche nach einem Benutzernamen.

Abbildung 13.1. JSON-Ausgabe nach der Suche nach einem Benutzernamen.


13.2. REST-Clients

Es gibt zahlreiche Möglichkeiten, eine Verbindung mit der Remote-API herzustellen. Die folgenden Listen geben einen Überblick über einige frei verfügbare Clients.

Browser Plugins

13.3. Dokumentation

Klaros-Test­management wird mit einer interaktiven Dokumentation für die Remote-API geliefert, auf die über einen Browser unter http:/{host}:{port}/klaros-web/api-doc/resources/ zugegriffen werden kann.

Remote-API Dokumentation

Abbildung 13.2. Remote-API Dokumentation