Générez la documentation de vos APIs avec apidoc

Magazine
Marque
GNU/Linux Magazine
Numéro
181
Mois de parution
avril 2015
Domaines


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 gestionnaire de paquets de node.js:

$ sudo...

Cet article est réservé aux abonnés. Il vous reste 93% à découvrir.
à partir de 21,65€ HT/mois/lecteur pour un accès 5 lecteurs à toute la plateforme
J'en profite


Articles qui pourraient vous intéresser...

Utiliser Visual Studio Code pour coder en Python

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Comme Batman a Robin, Rocket Raccoon a Groot, le développeur a l’éditeur de code. Sans son plus fidèle acolyte, impossible d’écrire la moindre ligne de code... d’où l’importance d’être toujours à la recherche de l’outil le plus efficace qui soit, quitte à délaisser un vieux compagnon de route...

Générez la documentation technique de vos projets Godot

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Découvrons comment utiliser GDScript Docs Maker pour générer automatiquement la documentation de vos projets Godot. Nous allons voir dans cet article que l’on peut simplement, à partir de notre code et de ses commentaires, avoir une documentation toujours à jour.

Implémentation du calcul symbolique et de la dérivation en Java

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Les logiciels de calcul symbolique sont relativement abondants. Pour les curieux ou ceux qui voudraient intégrer ce type de fonctionnalités dans leurs propres programmes, nous allons essayer de lever une partie des mystères des théories et des problèmes qui se cachent derrière la création de ces systèmes.