Spécialité(s)
Résumé
Vous voulez documenter les APIs de votre projet, qu'il soit en Java, JavaScript, Python, etc. ? Ne cherchez plus et adoptez apidoc pour séduire vos utilisateurs ou vos clients !
Apidoc permet de rédiger, comme d'autres outils, la documentation de vos APIs dans le code. Apidoc a l'avantage de fonctionner avec différents langages : JavaScript, Java, PHP, Python, etc. Les avantages que j'ai trouvé à cet outil par rapport à d'autres sont :
- la syntaxe claire ;
- le contenu généré au format HTML qui est très sympathique à lire ;
- la possibilité de versionner l'API et de pouvoir comparer simplement deux versions : un vrai plus pour les contributeurs ;
- même si le but premier est de documenter des APIs Web (REST), il est possible de détourner l'outil pour documenter l'utilisation d'une message queue (file de messages).
Il y a par contre à mon avis un petit défaut : node.js est nécessaire en tant que dépendance. Tout le monde ne sera pas forcément fan :).
1. Installation
Tout d'abord, il va falloir installer node.js :
$ sudo apt-get update
$ sudo apt-get install nodejs
Ensuite, nous allons installer npm, le...
Cet article est réservé aux abonnés. Il vous reste 93% à découvrir.
S'abonner à Connect
- Accédez à tous les contenus de Connect en illimité
- Découvrez des listes de lecture et des contenus Premium
- Consultez les nouveaux articles en avant-première
Déjà abonné ? Connectez-vous