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...

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...

Les mécanismes « exotiques » de Python

Magazine
Marque
GNU/Linux Magazine
Numéro
249
Mois de parution
juin 2021
Domaines
Résumé

Certains mécanismes de Python sont méconnus, peu utilisés. Ce n’est pas pour autant qu’ils sont inutiles, loin de là ! Dans cet article, nous allons faire un tour de quelques-unes de ces structures sous-employées.

Flutter 2 : l’alternative professionnelle

Magazine
Marque
GNU/Linux Magazine
Numéro
249
Mois de parution
juin 2021
Domaines
Résumé

Le 3 mars 2021, Google annonce Flutter 2 dans le premier événement « Flutter Engage ». La target Web/PWA devient stable et les targets desktop deviennent bêta avec une preview sur stable. Du côté Dart, la null safety devient la norme. Pendant ce temps, « Courses » se structure, adopte MVVM et devient non nullable !

Un bot qui surveille le Web et envoie des alertes

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
114
Mois de parution
mai 2021
Domaines
Résumé

De nos jours, lorsque l’on recherche une information, on se tourne immédiatement vers le Web. Ainsi, de très nombreuses informations sont mises à jour quotidiennement et il faut donc penser à visiter les sites les produisant, de manière à être au courant des dernières modifications. Et si nous codions un bot qui ferait cela pour nous ?