REST API

API Explorer Showcase

Ein Showcase für den interaktiven API Playground in Pharen Docs.

Diese Seite demonstriert die Nutzung des ::docs-api-endpoint Komponenten. Du kannst APIs direkt in der Dokumentation testen.

Einfacher API-Aufruf

Hier ist ein Beispiel für eine öffentliche API (The Free Joke API), die wir direkt hier ausprobieren können.

/random_joke

Du kannst auch Endpunkte mit Query-Parametern definieren.

/search/repositories

Du kannst auch erwartete Antworten dokumentieren.

200

Erfolgreiche Antwort

application/json

JSON

{
  "id": 1,
  "type": "general",
  "setup": "What do you call a fake noodle?",
  "punchline": "An impasta."
}

404

Nicht gefunden

application/json

JSON

{
  "error": "Not Found"
}

Hinweis

Kurzer Hinweistext.