Entwicklung · Fähigkeit

Was ist API-Design?

Auch: Schnittstellenentwurf · REST · Webservice · Programmierschnittstelle

Kurzantwort

API-Design API-Design ist der Entwurf von Programmierschnittstellen: welche Daten ein System nach außen anbietet, in welcher Form, unter welchen Adressen und mit welchen Regeln für Fehler, Zugriff und Änderungen. Eine gute Schnittstelle lässt sich benutzen, ohne dass man ihren inneren Aufbau kennt.

Kurz-Fakten

  • Fehlermeldungen sind Teil der Schnittstelle, nicht ein Nebenprodukt
  • Jede veröffentlichte Schnittstelle ist ein Versprechen mit Verfallsdatum
  • Versionierung von Anfang an spart den späteren Bruch
  • Dokumentation, die nicht mitgepflegt wird, ist schlechter als keine

Einordnung

Der Prüfstein ist immer derselbe: Kann jemand die Schnittstelle benutzen, ohne nachzufragen? Wenn die Antwort „nur wenn man weiß, dass …“ lautet, fehlt entweder Dokumentation oder das Design bildet interne Eigenheiten nach außen ab.

Wer API-Design angibt

Alphabetisch sortiert. Für eine Reihung nach Bestätigungen reicht die Datengrundlage bei dieser Fähigkeit noch nicht aus; die Reihenfolge sagt hier nichts aus. Stand: 16.08.2026.

Bisher führt niemand diese Fähigkeit in einem öffentlichen Profil. Profil anlegen und sie eintragen.

Verwandte Fähigkeiten