Javadoc automatiquement en ligne avec api123.io
Posté le Wednesday 7 October 2015 | Catégories : Java
Lorsqu'on développe une API Java, on souhaite généralement mettre la documentation javadoc en ligne afin de la rendre facilement accessible aux utilisateurs.
C'est là que le service api123.io arrive à la rescousse!
Ce service est capable de:
- Récupérer votre repository GIT (comme GitHub ou Bitbucket);
- Créer la documentation Javadoc de votre code;
- Publier la documentation en ligne.
De plus, grâce aux hooks, ce processus prend place automatiquement chaque fois que vous poussez (push) des modifications dans le repository GIT.
Créer un projet
Pour créer un projet, il suffit de remplir:
- le nom du projet,
- l'URL du repository GIT (par exemple https://github.com/google/guava.git)
- et le dossier dans lequel se trouve le code Java (par exemple guava/src ou alors src/main pour les projets maven)
Créer le hook sur GitHub
Sur la page du projet api123.io, se trouve le lien à utiliser pour le hook.
Pour ajouter ce hook à votre projet GitHub, il faut aller sur Settings puis Webhooks & services
Ensuite cliquer sur Add webhook, et dans le formulaire qui apparaît, indiquer:
- Payload URL: le lien du hook api123.io
- Content type: application/json
- Secret: laisser vide
- Just the push event.
C'est fait! Lors du prochain push votre documentation sera créée automatiquement et mise en ligne. Il ne reste plus qu'à partager le lien sur votre wiki, homepage etc.
