Wie nutze ich die eingebaute Doku, den Playground und das Request-Log?
REST API Pro bringt eine vollständige, interaktive Dokumentation gleich mit, du brauchst keine externen Tools, um die API zu verstehen und zu testen. Dazu kommt ein Request-Log mit Analytics, damit du jederzeit siehst, was an deiner API passiert.
📚 Eingebaute OpenAPI-3.1-Doku
Unter REST API Pro → API Docs findest du jede Ressource und jeden Endpunkt dokumentiert, inklusive filterbarer Spalten, Pflichtfeldern beim Anlegen und der einheitlichen JSON-Envelope. Die Doku wird aus einer lebenden OpenAPI-3.1-Spezifikation erzeugt, spiegelt also immer den tatsächlichen Stand deiner Installation wider. Zu jedem Endpunkt gibt es fertige Code-Beispiele in cURL, PHP, JavaScript und Python zum Kopieren.
🧪 Try-it-Playground: API im Browser testen
Das Highlight ist der Playground: Du wählst einen Endpunkt, trägst deinen API-Key ein, füllst Parameter oder einen JSON-Body aus und schickst die Anfrage direkt aus dem Browser ab. Die echte Antwort inklusive Statuscode und Laufzeit erscheint sofort. So probierst du eine Integration aus, bevor du eine einzige Zeile Code schreibst.
- Der Key, den du im Playground einträgst, wird nur in deinem Browser für diese Testaufrufe verwendet, ohne Cookies gesendet und nicht gespeichert.
- Perfekt, um schnell einen Endpunkt zu verifizieren oder einem Kollegen etwas zu demonstrieren.
📥 OpenAPI exportieren
Du kannst die OpenAPI-3.1-Spezifikation herunterladen ( /v1/openapi.json ) und direkt in Postman oder einen Code-Generator importieren. Damit erzeugst du im Handumdrehen Client-Bibliotheken oder eine Sammlung fertiger Requests.
📈 Request-Log & Analytics
Jeder API-Aufruf wird protokolliert, sofern das Log aktiviert ist. Unter Request Log siehst du zu jedem Call:
- Zeitpunkt, HTTP-Methode und Pfad
- Statuscode, Dauer (Latenz) und IP-Adresse
- einen maskierten Payload-Auszug (Secrets werden automatisch unkenntlich gemacht)
Du kannst nach Key, Ressource, Methode und Status filtern, nur Fehler (4xx/5xx) anzeigen oder nach Pfad und IP suchen. Ein Klick öffnet die Detailansicht einer Anfrage.
📊 Dashboard (Mission Control)
Das Dashboard fasst alles visuell zusammen: Traffic-Chart, Fehlerrate, durchschnittliche Latenz sowie die Top-Ressourcen und Top-Keys. So erkennst du auf einen Blick, ob deine API gesund läuft und wer sie wie stark nutzt.
🔧 Aufbewahrung
Wie lange Log-Einträge behalten werden, ob überhaupt geloggt wird und ob Request-Bodies (erste 2 KB, Secrets maskiert) mitgespeichert werden, stellst du in den Einstellungen ein.