AbfrageAPIs

AbfrageAPIs, oft auch als Query-APIs bezeichnet, sind Programmierschnittstellen, die überwiegend dem Abrufen von Daten dienen. Im Gegensatz zu Schnittstellen, die Ressourcen erstellen, aktualisieren oder löschen, konzentrieren sich Abfrage-APIs auf Leseoperationen. Typische Merkmale sind Endpunkte, über die Clients Anfragen mit Filtern, Projektionen, Sortierung und Paginierung formulieren, sowie die Rückgabe der Ergebnisse in maschinenlesbaren Formaten wie JSON oder XML.

Architektur- und Protokollformen variieren. Die verbreitetsten Varianten sind RESTful Abfrage-APIs, die Ressourcen über mehrere Endpunkte adressieren, sowie GraphQL-APIs, die eine einzige Endpunkt-URL verwenden und Clients ermöglichen, explizit Felder zu benennen. REST-APIs nutzen typischerweise HTTP-GET-Anfragen; GraphQL verwendet oft POST-Anfragen, um komplexe Abfragen zu definieren. Caching, IDs, ETags und Content Negotiation spielen eine Rolle.

Zu den Kernfunktionalitäten gehören Filtermöglichkeiten, Feldselektion (Projection), Sortierung und Paginierung, etwa Seiten- oder Cursor-Paginierung. Die Formate sind meist JSON; Fehler- und Statuscodes folgen gängigen API-Standards. Abfrage-APIs verlangen häufig Authentifizierung (API-Schlüssel, OAuth, JWT) und unterstützen Zugriffsbeschränkungen, Quoten und Logging. Typische Anwendungsfälle reichen von Suchfunktionen in Katalogen oder Open-Data-Portalen bis zu Finanz- oder Wetterdaten, die in Anwendungen verwendet werden.

Designprinzipien: Stabilität und Wartbarkeit, Versionierung und Abkündigungen, klare Fehlermeldungen, konsistente Paging- und Filtersignaturen sowie Sicherheits- und Compliance-Anforderungen. Performance-Optimierung erfolgt durch Caching, Ratenbegrenzung, effiziente Indizes und, bei GraphQL, Vermeidung teurer Nested-Queries. Gute Dokumentation und Beispiele erleichtern die Nutzung.