Pourquoi documenter une API ?
Une API non documentée oblige ses consommateurs à deviner.
Pour chaque opération
Documentez au minimum selon le projet :
Objectif
À quoi sert-elle ?
Entrées
Que faut-il envoyer ?
Authentification
Quel contexte d’accès ?
Réponse
Que reçoit-on ?
Erreurs
Quels cas peuvent survenir ?
Exemple
Comment utiliser l’opération ?
Pour qui ?
La documentation sert :
- au Front-End ;
- au mobile ;
- aux autres développeurs ;
- aux futurs mainteneurs ;
- parfois aux partenaires externes.
Test simple
Un nouveau développeur peut-il utiliser l’API sans demander oralement comment chaque endpoint fonctionne ?
Si non, la documentation mérite probablement d’être améliorée.
Formation Développement d’Applications et Solutions Connectées au CAFP Casablanca
Consultez la page principale de cette filière pour retrouver la durée, les conditions d’admission et les informations de préinscription.