APIFunktion

Eine APIFunktion ist eine klar benannte Funktionalität eines Application Programming Interface (API), die über ein Netz zugänglich ist und eine bestimmte Aufgabe ausführt oder Daten bereitstellt. In API-Architekturen werden solche Funktionen als Endpunkte oder Operationen modelliert, zum Beispiel als REST-Operationen über HTTP oder als Abfrage-Resolver in GraphQL. Typische Merkmale sind eine Endpunkt-URL, eine HTTP-Methode, Eingaben in Form von Parametern oder Payload, sowie eine definierte Ausgabenstruktur (Response-Body, Statuscodes). Die Funktionsausführung erfolgt oft unabhängig vom Client, sodass die APIFunktion stateless ist und durch Authentifizierung, Autorisierung, Ratenbegrenzung und Validierung geschützt wird.

Der Lebenszyklus umfasst Spezifikation, Implementierung, Versionierung und ggf. Deprecation. API-Schnittstellen sollten abwärtskompatibel bleiben oder Migrationen durch klare Versionen unterstützen. Entwurfskriterien beinhalten Single Responsibility, Idempotenz (wo sinnvoll), konsistente Namenskonventionen und robuste Fehlerbehandlung mit strukturierten Fehlermeldungen.

Betrieb und Qualität umfassen Dokumentation (z. B. OpenAPI), Tests (Unit-, Integrations- und Contract-Tests), sowie Observability (Logs, Metriken, verteiltes Tracing). Sicherheit umfasst Authentifizierung, Autorisierung, Eingabevalidierung, Transportverschlüsselung und Prinzipien der geringsten Privilegien.

Beispiele für APIFunktionen sind das Abfragen eines Nutzers, das Erstellen einer Bestellung oder das Aktualisieren eines Produktpreises. Die konkrete Gestaltung kann je nach API-Stil variieren, bleibt aber meist durch REST- oder RPC-ähnliche Muster geprägt.