Werner Vogels – 6 Erkenntnisse für gutes API-Design

 (aws.amazon.com)
30 Punkte von xguru 2022-01-26 | 4 Kommentare | Auf WhatsApp teilen
  • Notizen zu den „6 Prinzipien für gute APIs, die AWS in 15 Jahren gelernt hat“

  1. APIs sind für immer!

  2. Achtet auf Abwärtskompatibilität.

  3. Entwickelt rückwärts von den Anwendungsfällen der Kund:innen aus.

  4. Baut APIs, bei denen Fehler explizit sind.

  5. Baut APIs, deren Zweck und Nutzung sofort verständlich sind.

  6. Achtet darauf, dass keine Implementierungsdetails nach außen dringen.

  • Typische Fehler beim frühen API-Design

  • Hoch skalierbare APIs mit Smithy bauen

Verwandte Beiträge

4 Kommentare

 
xguru 2022-01-30
 
edunga1 2022-01-26

Punkt 5 hat mich besonders angesprochen.

Den verlinkten Beitrag „Ist so eine REST API wirklich in Ordnung?“ hatte ich schon einmal gesehen, und ich fand ihn gut: https://tv.naver.com/v/2292653

Auf solche semantischen? Informationen achte ich normalerweise nicht, aber wenn man sich die Github API ansieht, liefert sie auch solche Informationen sauber mit aus, sodass man den Eindruck bekommt, dass sie gut gemacht ist.
 
ehlegeth 2022-01-26

Das scheint ein guter Inhalt zu sein.

Vor allem die Punkte 1 und 4 sind wohl Themen, die ich bei Reviews immer wieder anspreche.

Punkt 3 scheint den Gedanken zu berühren, den Joshua Bloch mit "Write to Your API Early and Often" beschrieben hat. (https://www.youtube.com/watch?v=aAb7hSCtvGw)
 
nicewook 2022-01-26

Wenn man es so zusammenfasst, wirkt es selbstverständlich, aber in der Praxis merkt man doch, dass man dieselben Fehler immer wieder macht.