La mauvaise utilisation dès la conception
Pourquoi c'est important La plupart des bogues à la frontière d'une API ne sont pas dans l'API. Ils sont chez un appelant qui l'a utilisée d'une façon qui avait l'air correcte et qui a fait la mauvaise chose en silence. Tu ne peux pas corriger chaque appelant ; tu peux rendre la mauvaise utilisation impossible, ou bruyante.
Un assistant qui écrit une API a tendance à rendre service : si tu envoies avant de te connecter, il se connecte pour toi ; si tu passes une chaîne là où on attendait des octets, il l'encode ; si tu oublies une option, il y a une valeur par défaut. Chaque gentillesse cache une erreur jusqu'à ce qu'elle refasse surface très loin.
Échouer tôt, échouer bruyamment : lever une erreur exactement à l'appel qui est faux, avant que quoi que ce soit ait changé, avec un message qui dit ce qui était attendu.
Quatre outils
- Des états explicites : un objet qui sait s'il est nouveau, ouvert ou fermé, et refuse les appels qui ne conviennent pas.
- Des options nommées, pas de booléens :
mode="dry_run"ne peut pas être échangé par accident avec une autre option ;copy(a, b, True, False)si. - Pas de valeurs par défaut silencieuses pour les choix dangereux à rater : fais-les dire à l'appelant.
- Des types porteurs de sens : de l'argent qui connaît sa devise ne peut pas être ajouté à de l'argent dans une autre.
Dans ce module, des scripts de mauvaise utilisation cachés appellent ton API de travers et attendent une erreur au mauvais appel, sans que rien ne change. Des scripts d'utilisation correcte s'attendent à ce que ça marche simplement. Chaque problème liste les mauvaises utilisations contre lesquelles se protéger.
Récap Les suppositions serviables cachent des bogues. Refuse la mauvaise utilisation à l'appel qui est faux, avant tout effet.
Tu as repéré un problème dans cette leçon ? Signale-le · Pose une question sur cette leçon
Cet exercice s'ouvre bientôt
Termine la leçon précédente pour débloquer celle-ci. Tout le cours est gratuit, aucun compte n'est requis, et tu peux lire cette leçon dès maintenant.
Ce navigateur bloque les cookies pour learn.floati.life, donc les leçons que tu as terminées ici ne peuvent pas s'ouvrir dans l'ordre. Autorise les cookies pour ce site et recharge la page.