Contract First ou mourir en essayant : La seule façon sensée de concevoir des APIs

Je dois vider mon sac. Quelque chose qui ronge mon âme depuis la première fois que j’ai rejoint un projet en cours de développement et que j’ai posé la question fatidique : « Où est la documentation de l’API ? »

La réponse était invariablement l’une des suivantes :

1. « Regarde la collection Postman. » (Traduction : un cimetière de 200 requêtes, dont la moitié est obsolète, nommées des choses comme GET users FINAL v2 (copie))
2. « Regarde juste le code. » (Traduction : reverse-engineer notre spaghetti et bonne chance)
3. « On la documentera plus tard. » (Traduction : on ne la documentera jamais)