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

Magazine
Marque
GNU/Linux Magazine
Numéro
181
Mois de parution
avril 2015
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
Je m'abonne


Article rédigé par

Par le(s) même(s) auteur(s)

Témoignage : Golang vs Python… le retour de l’XP !

Magazine
Marque
GNU/Linux Magazine
Numéro
232
Mois de parution
décembre 2019
Spécialité(s)
Résumé

Mesdames, Messieurs… Here come the challengers !!!À droite, voici Python qui rentre sur le ring ! Avec sa trentaine d’années et ses 3 versions majeures, il a prouvé moult fois qu’il est un grand champion !!!À « go »che, du haut de ses 10 ans, voici le jeune challenger Go ! Sponsorisé par le grand sournois Google, il a atteint la maturité et a tout d’un grand désormais !!!Go ou Python, qui va gagner ce rude combat ??? Nous le saurons dans quelques rounds (ou pages) ! Et maintenant, faites entrer l’arbitre…. Fred ! Avec ses quelques années de développement en Python à son actif, mais seulement quelques mois de Golang derrière lui, le public se demande s'il sera vraiment intègre….

Comment bien transmettre ses mots de passe...

Magazine
Marque
GNU/Linux Magazine
Numéro
225
Mois de parution
avril 2019
Spécialité(s)
Résumé
… et autres données critiques ! La transmission de mots de passe à un tiers est très/trop souvent mal réalisée de nos jours. Ceci est malheureusement aussi vrai dans la population des informaticiens de métier (un comble!). Faisons un petit bilan des erreurs à éviter et comment procéder.

Mais quelle est la meilleure méthode pour transférer un grand nombre de petits fichiers ?

Magazine
Marque
GNU/Linux Magazine
Numéro
211
Mois de parution
janvier 2018
Spécialité(s)
Résumé
À l’heure des webservices et des websockets le transfert d’informations par fichiers peut sembler obsolète. Obsolète ou pas, il est fréquemment utilisé en entreprise. Mais derrière ce sujet simple peuvent se cacher des problèmes de performance…

Les derniers articles Premiums

Les derniers articles Premium

La place de l’Intelligence Artificielle dans les entreprises

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

L’intelligence artificielle est en train de redéfinir le paysage professionnel. De l’automatisation des tâches répétitives à la cybersécurité, en passant par l’analyse des données, l’IA s’immisce dans tous les aspects de l’entreprise moderne. Toutefois, cette révolution technologique soulève des questions éthiques et sociétales, notamment sur l’avenir des emplois. Cet article se penche sur l’évolution de l’IA, ses applications variées, et les enjeux qu’elle engendre dans le monde du travail.

Petit guide d’outils open source pour le télétravail

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Ah le Covid ! Si en cette période de nombreux cas resurgissent, ce n’est rien comparé aux vagues que nous avons connues en 2020 et 2021. Ce fléau a contraint une large partie de la population à faire ce que tout le monde connaît sous le nom de télétravail. Nous avons dû changer nos habitudes et avons dû apprendre à utiliser de nombreux outils collaboratifs, de visioconférence, etc., dont tout le monde n’était pas habitué. Dans cet article, nous passons en revue quelques outils open source utiles pour le travail à la maison. En effet, pour les adeptes du costume en haut et du pyjama en bas, la communauté open source s’est démenée pour proposer des alternatives aux outils propriétaires et payants.

Sécurisez vos applications web : comment Symfony vous protège des menaces courantes

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Les frameworks tels que Symfony ont bouleversé le développement web en apportant une structure solide et des outils performants. Malgré ces qualités, nous pouvons découvrir d’innombrables vulnérabilités. Cet article met le doigt sur les failles de sécurité les plus fréquentes qui affectent même les environnements les plus robustes. De l’injection de requêtes à distance à l’exécution de scripts malveillants, découvrez comment ces failles peuvent mettre en péril vos applications et, surtout, comment vous en prémunir.

Bash des temps modernes

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Les scripts Shell, et Bash spécifiquement, demeurent un standard, de facto, de notre industrie. Ils forment un composant primordial de toute distribution Linux, mais c’est aussi un outil de prédilection pour implémenter de nombreuses tâches d’automatisation, en particulier dans le « Cloud », par eux-mêmes ou conjointement à des solutions telles que Ansible. Pour toutes ces raisons et bien d’autres encore, savoir les concevoir de manière robuste et idempotente est crucial.

Les listes de lecture

9 article(s) - ajoutée le 01/07/2020
Vous désirez apprendre le langage Python, mais ne savez pas trop par où commencer ? Cette liste de lecture vous permettra de faire vos premiers pas en découvrant l'écosystème de Python et en écrivant de petits scripts.
11 article(s) - ajoutée le 01/07/2020
La base de tout programme effectuant une tâche un tant soit peu complexe est un algorithme, une méthode permettant de manipuler des données pour obtenir un résultat attendu. Dans cette liste, vous pourrez découvrir quelques spécimens d'algorithmes.
10 article(s) - ajoutée le 01/07/2020
À quoi bon se targuer de posséder des pétaoctets de données si l'on est incapable d'analyser ces dernières ? Cette liste vous aidera à "faire parler" vos données.
Voir les 65 listes de lecture

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous