🔗 REST API-Zugriff via Swagger

📄Inhalte

A) 🔗 Swagger-Dokumentation aufrufen
B) 🔐 Bearer Token ermitteln
C) 🔐 Swagger Authorisierung
D) 📂 API auswählen
E) 🚀 API aufrufen („Try it out“)
F) ✅ Ergebnis
G) 🎯 Wie dir diese Anleitung bei der Nutzung der REST API hilft

A) 🔗 Swagger-Dokumentation aufrufen

Öffne die folgende URL in deinem Browser, um die interaktive API-Dokumentation zu sehen:

B) 🔐 Bearer Token ermitteln

Damit du in Swagger authentifiziert bist, brauchst du einen Bearer Token. So findest du ihn:

1. Logge dich in deinen Casebase-Account ein
   → z. B. https://demo.casebase.ai

2. Öffne die Entwicklertools
   → Rechtsklick → "Untersuchen" oder F12 drücken

3. Gehe zum Tab „Netzwerk“ (Network)
   Lade ggf. die Seite neu, damit die Requests erscheinen.

4. Suche (Strg + F) nach dem Begriff „Bearer“  oder klicke auf einen Request, der einen Autorisierungsheader enthält
   
   
   

5. Kopiere den Token aus dem Header
   → Authorization: Bearer eyJhbGciOi...
   → Nur den Token kopieren, ohne das Wort „Bearer“

C) 🔐 Swagger Authorisierung

1. Öffne die Swagger-UI:
   https://demo.casebase.ai/api/v1/swagger-ui/index.html

2. Klicke oben rechts auf Authorize

3. Füge den kopierten Token ein im Format:

   eyJhbGciOi...


4. Klicke auf Authorize, danach auf Close

D) 📂 API auswählen

Jetzt bist du authentifiziert. Du kannst eine beliebige API testen:

1. Scrolle oder suche z. B. nach:
   WorkspaceUseCaseController → GET /api/v1/workspaces/{workspaceId}/use-cases

2. Klicke auf den Eintrag, um Details zu sehen.

E) 🚀 API aufrufen („Try it out“)

1. Klicke auf Try it out

2. Füge die Workspace ID ein
   → Gehe zurück zu deinem Casebase-Konto
   → Entwicklertools öffnen → Netzwerk → Suche nach „workspaces“
   → Kopiere eine ID (z. B. c2c3f1c3-0e7b-4e7b-9c21...)

3. Füge die Use Case ID ein
   → In ähnlicher Weise im Netzwerk-Tab nach „id“ oder „use-case“ suchen
   → Pfadparameter eintragen

4. Wähle deine aktuell verwendete Login-Methode:

   • AD = SSO via Microsoft

   • PW = E-Mail & Passwort

5. Klicke auf Execute

F) ✅ Ergebnis

Du erhältst nun die API-Antwort direkt im Swagger-Interface und siehts nun bspw. direkt:

• Den HTTP-Statuscode (z. B. 200 OK)

• Die Response-Daten (z. B. JSON mit Use Cases)

• Die gesendeten Header & Payloads

G) 🎯 Wie dir diese Anleitung bei der Nutzung der REST API hilft

1. Verstehen, was die API kann

In Swagger siehst du:

• Alle verfügbaren Endpunkte (z. B. /use-cases, /workspaces)

• Die HTTP-Methode (GET, POST, PUT, DELETE)

• Was du schicken musst (Parameter, Body)

• Was du als Antwort bekommst

➡ Du weißt genau, wie du mit der API interagierst.

2. Authentifizierung nachvollziehen und nutzen

APIs sind meist geschützt – ohne Token kein Zugriff.
Du lernst:

• Wie du einen gültigen Bearer Token bekommst

• Wie du ihn in Swagger richtig einsetzt

➡ Du kannst autorisierte Anfragen an die API stellen – wie ein echter Client.

3. Praktisch testen, bevor du Code schreibst

Du kannst alle API-Aufrufe in Swagger direkt testen:

• Use Case abrufen

• Workspace erstellen

• Daten aktualisieren oder löschen

➡ Du siehst sofort, ob deine Anfrage funktioniert – ohne Code schreiben zu müssen.

4. Hilft bei der Entwicklung (z. B. mit Postman oder im Code)

Nachdem du weißt, welche Anfrage funktioniert:

• Kannst du denselben Aufruf in Postman testen

• Oder direkt in deinem Code (z. B. mit fetch(), axios, curl) nachbauen

➡ Du überträgst das Gelernte aus Swagger 1:1 in deine Anwendung.