Werner Vogels – 6 leçons retenues pour concevoir de bonnes API

 (aws.amazon.com)
30 points par xguru 2022-01-26 | 4 commentaires | Partager sur WhatsApp
  • Notes sur les « 6 principes pour créer de bonnes API qu’AWS a appris en 15 ans »

  1. Une API est éternelle !

  2. Veuillez préserver la compatibilité descendante.

  3. Concevez en partant à rebours des cas d’usage client.

  4. Créez des API où les erreurs sont explicites.

  5. Créez des API dont on peut immédiatement comprendre l’objectif et l’usage.

  6. Veillez à ce que les détails d’implémentation ne fuitent pas.

  • Les erreurs commises lors de la conception initiale d’une API

  • Créer des API hautement extensibles avec Smithy

À lire aussi

4 commentaires

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

Le 5e point m’a particulièrement parlé.

J’avais déjà vu le « Une API REST comme ça, est-ce que ça va ? », qui est référencé, et je l’avais trouvé bien : https://tv.naver.com/v/2292653

Je ne fais pas trop attention à ce genre d’informations sémantiques, mais quand on regarde l’API de GitHub, elle renvoie aussi très bien ce type d’informations, ce qui donne l’impression qu’elle est bien conçue.
 
ehlegeth 2022-01-26

Je trouve le contenu très pertinent.

En particulier, les points 1 et 4 font partie des sujets que j’aborde toujours lors des revues.

Le point 3 semble aussi rejoindre ce dont parlait Joshua Bloch : "Write to Your API Early and Often". (https://www.youtube.com/watch?v=aAb7hSCtvGw)
 
nicewook 2022-01-26

Quand on l’organise ainsi, cela paraît évident, mais au moment de le faire en pratique, on se rend compte qu’on répète sans cesse les mêmes erreurs.