API-Design

API-Design-Patterns

Konventionen und Best Practices für das Design konsistenter, entwicklerfreundlicher REST-APIs.

Wann zu aktivieren

• Entwerfen neuer API-Endpunkte
• Überprüfen bestehender API-Verträge
• Hinzufügen von Paginierung, Filterung oder Sortierung
• Implementieren von Fehlerbehandlung für APIs
• Planen der API-Versionierungsstrategie
• Erstellen öffentlicher oder partnerorientierter APIs

Ressourcen-Design

URL-Struktur

# Ressourcen sind Nomen, Plural, lowercase, kebab-case
GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
PATCH  /api/v1/users/:id
DELETE /api/v1/users/:id

# Unterressourcen für Beziehungen
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# Aktionen, die nicht auf CRUD abbildbar sind (sparsam mit Verben)
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh

Namensregeln

# GUT
/api/v1/team-members          # kebab-case für mehrteilige Ressourcen
/api/v1/orders?status=active  # Query-Parameter zum Filtern
/api/v1/users/123/orders      # Verschachtelte Ressourcen für Besitzverhältnisse

# SCHLECHT
/api/v1/getUsers              # Verb in der URL
/api/v1/user                  # Singular (Plural verwenden)
/api/v1/team_members          # snake_case in URLs
/api/v1/users/123/getOrders   # Verb in verschachtelter Ressource

HTTP-Methoden und Statuscodes

Methodensemantik

Methode	Idempotent	Sicher	Verwendung
GET	Ja	Ja	Ressourcen abrufen
POST	Nein	Nein	Ressourcen erstellen, Aktionen auslösen
PUT	Ja	Nein	Vollständiges Ersetzen einer Ressource
PATCH	Nein*	Nein	Teilweises Aktualisieren einer Ressource
DELETE	Ja	Nein	Ressource entfernen

*PATCH kann bei korrekter Implementierung idempotent gemacht werden

Statuscode-Referenz

# Erfolg
200 OK                    — GET, PUT, PATCH (mit Antworttext)
201 Created               — POST (Location-Header einfügen)
204 No Content            — DELETE, PUT (kein Antworttext)

# Client-Fehler
400 Bad Request           — Validierungsfehler, fehlerhaftes JSON
401 Unauthorized          — Fehlende oder ungültige Authentifizierung
403 Forbidden             — Authentifiziert, aber nicht berechtigt
404 Not Found             — Ressource existiert nicht
409 Conflict              — Doppelter Eintrag, Konflikt
422 Unprocessable Entity  — Semantisch ungültig (gültiges JSON, fehlerhafte Daten)
429 Too Many Requests     — Ratengrenze überschritten

# Server-Fehler
500 Internal Server Error — Unerwarteter Fehler (niemals Details preisgeben)
502 Bad Gateway           — Upstream-Dienst fehlgeschlagen
503 Service Unavailable   — Vorübergehende Überlastung, Retry-After angeben

Häufige Fehler

# SCHLECHT: 200 für alles
{ "status": 200, "success": false, "error": "Not found" }

# GUT: HTTP-Statuscodes semantisch verwenden
HTTP/1.1 404 Not Found
{ "error": { "code": "not_found", "message": "User not found" } }

# SCHLECHT: 500 für Validierungsfehler
# GUT: 400 oder 422 mit Details auf Feldebene

# SCHLECHT: 200 für erstellte Ressourcen
# GUT: 201 mit Location-Header
HTTP/1.1 201 Created
Location: /api/v1/users/abc-123

Antwortformat

Erfolgsantwort

{
  "data": {
    "id": "abc-123",
    "email": "[email protected]",
    "name": "Alice",
    "created_at": "2025-01-15T10:30:00Z"
  }
}

Sammlungsantwort (mit Paginierung)

{
  "data": [
    { "id": "abc-123", "name": "Alice" },
    { "id": "def-456", "name": "Bob" }
  ],
  "meta": {
    "total": 142,
    "page": 1,
    "per_page": 20,
    "total_pages": 8
  },
  "links": {
    "self": "/api/v1/users?page=1&per_page=20",
    "next": "/api/v1/users?page=2&per_page=20",
    "last": "/api/v1/users?page=8&per_page=20"
  }
}

Fehlerantwort

{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "details": [
      {
        "field": "email",
        "message": "Must be a valid email address",
        "code": "invalid_format"
      },
      {
        "field": "age",
        "message": "Must be between 0 and 150",
        "code": "out_of_range"
      }
    ]
  }
}

Antwort-Hüllenvarianten

// Option A: Hülle mit Datenwrapper (empfohlen für öffentliche APIs)
interface ApiResponse<T> {
  data: T;
  meta?: PaginationMeta;
  links?: PaginationLinks;
}

interface ApiError {
  error: {
    code: string;
    message: string;
    details?: FieldError[];
  };
}

// Option B: Flache Antwort (einfacher, üblich für interne APIs)
// Erfolg: Ressource direkt zurückgeben
// Fehler: Fehlerobjekt zurückgeben
// Unterscheidung durch HTTP-Statuscode

Paginierung

Offset-basiert (Einfach)

GET /api/v1/users?page=2&per_page=20

# Implementierung
SELECT * FROM users
ORDER BY created_at DESC
LIMIT 20 OFFSET 20;

Vorteile: Einfach zu implementieren, unterstützt "Springe zu Seite N" Nachteile: Langsam bei großen Offsets (OFFSET 100000), inkonsistent bei gleichzeitigen Einfügungen

Cursor-basiert (Skalierbar)

GET /api/v1/users?cursor=eyJpZCI6MTIzfQ&limit=20

# Implementierung
SELECT * FROM users
WHERE id > :cursor_id
ORDER BY id ASC
LIMIT 21;  -- einen zusätzlichen abrufen, um has_next zu bestimmen

{
  "data": [...],
  "meta": {
    "has_next": true,
    "next_cursor": "eyJpZCI6MTQzfQ"
  }
}

Vorteile: Konsistente Leistung unabhängig von der Position, stabil bei gleichzeitigen Einfügungen Nachteile: Kann nicht zu einer beliebigen Seite springen, Cursor ist undurchsichtig

Wann welches verwenden

Anwendungsfall	Paginierungstyp
Admin-Dashboards, kleine Datensätze (<10K)	Offset
Unendliches Scrollen, Feeds, große Datensätze	Cursor
Öffentliche APIs	Cursor (Standard) mit Offset (optional)
Suchergebnisse	Offset (Benutzer erwarten Seitenzahlen)

Filterung, Sortierung und Suche

Filterung

# Einfache Gleichheit
GET /api/v1/orders?status=active&customer_id=abc-123

# Vergleichsoperatoren (Klammernotation verwenden)
GET /api/v1/products?price[gte]=10&price[lte]=100
GET /api/v1/orders?created_at[after]=2025-01-01

# Mehrere Werte (Komma-getrennt)
GET /api/v1/products?category=electronics,clothing

# Verschachtelte Felder (Punktnotation)
GET /api/v1/orders?customer.country=US

Sortierung

# Einzelfeld (Präfix - für absteigend)
GET /api/v1/products?sort=-created_at

# Mehrere Felder (Komma-getrennt)
GET /api/v1/products?sort=-featured,price,-created_at

Volltextsuche

# Suchabfrage-Parameter
GET /api/v1/products?q=wireless+headphones

# Feldspezifische Suche
GET /api/v1/users?email=alice

Selektion einzelner Felder

# Nur angegebene Felder zurückgeben (reduziert Payload)
GET /api/v1/users?fields=id,name,email
GET /api/v1/orders?fields=id,total,status&include=customer.name

Authentifizierung und Autorisierung

Token-basierte Authentifizierung

# Bearer-Token im Authorization-Header
GET /api/v1/users
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

# API-Key (für Server-zu-Server)
GET /api/v1/data
X-API-Key: sk_live_abc123

Autorisierungsmuster

// Ressourcenebene: Besitz prüfen
app.get("/api/v1/orders/:id", async (req, res) => {
  const order = await Order.findById(req.params.id);
  if (!order) return res.status(404).json({ error: { code: "not_found" } });
  if (order.userId !== req.user.id) return res.status(403).json({ error: { code: "forbidden" } });
  return res.json({ data: order });
});

// Rollenbasiert: Berechtigungen prüfen
app.delete("/api/v1/users/:id", requireRole("admin"), async (req, res) => {
  await User.delete(req.params.id);
  return res.status(204).send();
});

Rate Limiting

Header

HTTP/1.1 200 OK
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

# Wenn überschritten
HTTP/1.1 429 Too Many Requests
Retry-After: 60
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 60 seconds."
  }
}

Ratengrenzen-Stufen

Stufe	Grenze	Fenster	Anwendungsfall
Anonym	30/min	Pro IP	Öffentliche Endpunkte
Authentifiziert	100/min	Pro Benutzer	Standard-API-Zugriff
Premium	1000/min	Pro API-Key	Bezahlte API-Pläne
Intern	10000/min	Pro Dienst	Dienst-zu-Dienst

Versionierung

URL-Pfad-Versionierung (Empfohlen)

/api/v1/users
/api/v2/users

Vorteile: Explizit, einfach zu routen, cachebar Nachteile: URL ändert sich zwischen Versionen

Header-Versionierung

GET /api/users
Accept: application/vnd.myapp.v2+json

Vorteile: Saubere URLs Nachteile: Schwerer zu testen, leicht zu vergessen

Versionierungsstrategie

1. Mit /api/v1/ beginnen — erst versionieren, wenn nötig
2. Maximal 2 aktive Versionen beibehalten (aktuell + vorherige)
3. Abkündigungszeitplan:
   - Abkündigung ankündigen (6 Monate Vorlauf für öffentliche APIs)
   - Sunset-Header hinzufügen: Sunset: Sat, 01 Jan 2026 00:00:00 GMT
   - Nach Sunset-Datum 410 Gone zurückgeben
4. Nicht unterbrechende Änderungen benötigen keine neue Version:
   - Neue Felder zu Antworten hinzufügen
   - Neue optionale Query-Parameter hinzufügen
   - Neue Endpunkte hinzufügen
5. Unterbrechende Änderungen erfordern eine neue Version:
   - Felder entfernen oder umbenennen
   - Feldtypen ändern
   - URL-Struktur ändern
   - Authentifizierungsmethode ändern

Implementierungsmuster

TypeScript (Next.js API Route)

import { z } from "zod";
import { NextRequest, NextResponse } from "next/server";

const createUserSchema = z.object({
  email: z.string().email(),
  name: z.string().min(1).max(100),
});

export async function POST(req: NextRequest) {
  const body = await req.json();
  const parsed = createUserSchema.safeParse(body);

  if (!parsed.success) {
    return NextResponse.json({
      error: {
        code: "validation_error",
        message: "Request validation failed",
        details: parsed.error.issues.map(i => ({
          field: i.path.join("."),
          message: i.message,
          code: i.code,
        })),
      },
    }, { status: 422 });
  }

  const user = await createUser(parsed.data);

  return NextResponse.json(
    { data: user },
    {
      status: 201,
      headers: { Location: `/api/v1/users/${user.id}` },
    },
  );
}

Python (Django REST Framework)

from rest_framework import serializers, viewsets, status
from rest_framework.response import Response

class CreateUserSerializer(serializers.Serializer):
    email = serializers.EmailField()
    name = serializers.CharField(max_length=100)

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ["id", "email", "name", "created_at"]

class UserViewSet(viewsets.ModelViewSet):
    serializer_class = UserSerializer
    permission_classes = [IsAuthenticated]

    def get_serializer_class(self):
        if self.action == "create":
            return CreateUserSerializer
        return UserSerializer

    def create(self, request):
        serializer = CreateUserSerializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        user = UserService.create(**serializer.validated_data)
        return Response(
            {"data": UserSerializer(user).data},
            status=status.HTTP_201_CREATED,
            headers={"Location": f"/api/v1/users/{user.id}"},
        )

Go (net/http)

func (h *UserHandler) CreateUser(w http.ResponseWriter, r *http.Request) {
    var req CreateUserRequest
    if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
        writeError(w, http.StatusBadRequest, "invalid_json", "Invalid request body")
        return
    }

    if err := req.Validate(); err != nil {
        writeError(w, http.StatusUnprocessableEntity, "validation_error", err.Error())
        return
    }

    user, err := h.service.Create(r.Context(), req)
    if err != nil {
        switch {
        case errors.Is(err, domain.ErrEmailTaken):
            writeError(w, http.StatusConflict, "email_taken", "Email already registered")
        default:
            writeError(w, http.StatusInternalServerError, "internal_error", "Internal error")
        }
        return
    }

    w.Header().Set("Location", fmt.Sprintf("/api/v1/users/%s", user.ID))
    writeJSON(w, http.StatusCreated, map[string]any{"data": user})
}

API-Design-Checkliste

Vor dem Ausliefern eines neuen Endpunkts:

• Ressourcen-URL folgt Namenskonventionen (Plural, kebab-case, keine Verben)
• Korrekte HTTP-Methode verwendet (GET für Lesezugriffe, POST für Erstellungen usw.)
• Angemessene Statuscodes zurückgegeben (nicht 200 für alles)
• Eingabe mit Schema validiert (Zod, Pydantic, Bean Validation)
• Fehlerantworten folgen Standardformat mit Codes und Meldungen
• Paginierung für Listen-Endpunkte implementiert (Cursor oder Offset)
• Authentifizierung erforderlich (oder explizit als öffentlich markiert)
• Autorisierung überprüft (Benutzer können nur auf eigene Ressourcen zugreifen)
• Rate Limiting konfiguriert
• Antwort gibt keine internen Details preis (Stacktraces, SQL-Fehler)
• Konsistente Benennung mit bestehenden Endpunkten (camelCase vs snake_case)
• Dokumentiert (OpenAPI/Swagger-Spezifikation aktualisiert)