in REST APIs sauber entwerfen
List-Endpoints sind die komplexesten Teile einer REST API: Sie müssen Pagination, Filterung und Sortierung konsistent unterstützen, ohne die API-Oberfläche aufzublasen. Der Unterschied zwischen einem gut und einem schlecht entworfenen List-Endpoint liegt in drei Entscheidungen: Cursor oder Offset, welche Filterparameter erlaubt, und wie das Meta-Objekt die Konsumenten informiert.
Inhaltsverzeichnis
- 1. Die Grundentscheidung: Cursor oder Offset?
- 2. Offset-Pagination: einfach, aber mit Grenzen
- 3. Cursor-Pagination: konsistent bei veränderlichen Daten
- 4. Das Meta-Objekt: was Konsumenten wirklich brauchen
- 5. Filter-Parameter: Syntax, Typen und Grenzen
- 6. Sortierung: einfach konsistent halten
- 7. List-Endpoints vollständig in OpenAPI dokumentieren
- 8. Performance-Überlegungen für Pagination