Zum Inhalt springen
BeispielWerk
English

API-Antworten als JSON: Liste, Fehler 400 bis 503

Eine API-Antwort besteht aus Statuscode und JSON-Rumpf; bei Listen kommt eine Paginierung dazu, bei Fehlern ein Objekt mit Code und Nachricht. Die Seite zeigt Erfolgsantworten mit 200 und typische Fehlerfälle, mit denen sich Anzeige, Fehlerbehandlung und Wiederholungslogik eines Clients ohne echten Server prüfen lassen. Die Inhalte sind überwiegend erfundene Beispiele.

20 Varianten auf einer Seite, jede mit eigenem Kopier- oder Download-Knopf. Darunter: 19× Fiktiv, 1× Öffentliches Beispiel.

  • API-Antwort: Liste mit Seitenzahl-Paginierung (200)Fiktiv

    {
      "daten": [
        { …
  • API-Antwort: Liste mit Cursor-Paginierung (200)Fiktiv

    {
      "daten": [
        { …

    Der Cursor ist ein erfundener, undurchsichtiger Wert.

  • API-Antwort: letzte Seite einer Liste (200)Fiktiv

    {
      "daten": [
        { …
  • API-Antwort: leere Liste (200)Fiktiv

    {
      "daten": [],
      "meta": { …
  • API-Antwort: einzelne Ressource (200)Fiktiv

    {
      "daten": {
        "id": "8b0e58ba-8cf3-4e66-8260-44529a48536c", …
  • API-Antwort: Ressource angelegt (201)Fiktiv

    {
      "daten": {
        "id": "8b0e58ba-8cf3-4e66-8260-44529a48536c", …

    Üblich ist zusätzlich ein Location-Header mit der Adresse der neuen Ressource.

  • API-Fehler 400: ungültige AnfrageFiktiv

    {
      "fehler": {
        "code": "ungueltige_anfrage", …
  • API-Fehler 401: nicht angemeldetFiktiv

    {
      "fehler": {
        "code": "nicht_angemeldet", …
  • API-Fehler 403: keine BerechtigungFiktiv

    {
      "fehler": {
        "code": "verboten", …
  • API-Fehler 404: nicht gefundenFiktiv

    {
      "fehler": {
        "code": "nicht_gefunden", …
  • API-Fehler 409: Konflikt (Duplikat)Fiktiv

    {
      "fehler": {
        "code": "konflikt", …
  • API-Fehler 422: Validierung mit FeldfehlernFiktiv

    {
      "fehler": {
        "code": "validierung_fehlgeschlagen", …
  • API-Fehler 429: zu viele AnfragenFiktiv

    {
      "fehler": {
        "code": "zu_viele_anfragen", …
  • API-Fehler 500: interner FehlerFiktiv

    {
      "fehler": {
        "code": "interner_fehler", …
  • API-Fehler 503: WartungFiktiv

    {
      "fehler": {
        "code": "nicht_verfuegbar", …
  • API-Fehler im Format RFC 9457 (application/problem+json)Öffentliches Beispiel

    {
      "type": "https://example.com/probleme/validierung",
      "title": "Eingabe ungültig", …

    Felder type, title, status, detail, instance stammen aus RFC 9457; "fehler" ist eine erfundene Erweiterung.

  • API-Antwort 429 mit Ratenlimit-Kopfzeilen (roh)Fiktiv

    HTTP/1.1 429 Too Many Requests
    Content-Type: application/json
    Retry-After: 23 …

    Die X-RateLimit-Kopfzeilen sind eine verbreitete Konvention ohne Norm; Retry-After ist in RFC 9110 definiert.

  • API-Antwort: Teilerfolg mit Fehlerliste (JSON)Fiktiv

    {
      "daten": [
        { …

    Mehrfach-Anlage mit einem fehlerhaften Eintrag; manche APIs antworten dafür mit 207.

  • API-Antwort: Health-Check mit Abhängigkeiten (200)Fiktiv

    {
      "status": "ok",
      "version": "1.4.2", …
  • API-Antwort: OAuth-ähnliche Token-Ausgabe mit PlatzhalternFiktiv

    {
      "access_token": "<ZUGRIFFSTOKEN>",
      "token_type": "Bearer", …

    Die Token sind Platzhalter in spitzen Klammern, keine echten oder echt aussehenden Werte.

Weitere Themen in Mock-Daten & API-Antworten