Technologie

API-Design für modulare Systeme

ThemaAPI-Architektur & Software-DesignKategorieTechnologie APIs als Verträge Eine API ist kein Implementierungsdetail – sie ist ein Versprechen. Wer sie ändert, ohne an bestehende Konsumenten zu denke…

ThemaAPI-Architektur & Software-Design
KategorieTechnologie

APIs als Verträge

Eine API ist kein Implementierungsdetail – sie ist ein Versprechen. Wer sie ändert, ohne an bestehende Konsumenten zu denken, bricht dieses Versprechen.

Grundregeln

  • Konsistente Benennung über alle Endpunkte
  • Versioning von Anfang an: /v1/, /v2/ oder Header-basiert
  • Klare Fehlercodes mit aussagekräftigen Messages
  • Pagination für alle Listen-Endpunkte

REST vs. GraphQL vs. gRPC

REST ist gut verständlich und weit verbreitet. GraphQL gibt Clients mehr Kontrolle, erhöht aber Komplexität auf Serverseite. gRPC eignet sich für interne Service-Kommunikation mit hohem Durchsatz.

Fazit

Gute APIs entstehen durch klare Entscheidungen, konsequente Dokumentation und den Willen, Breaking Changes zu vermeiden.