J'ai développé une API assez étendue, et je l'ai sur Postman, qui fonctionne plutôt bien. Maintenant, je dois générer un doc html pour le garder versionné dans/docs avec mes sources.Création d'un document html à partir de la collection de postiers
Existe-t-il un outil ou un moyen d'y parvenir? Je ne veux vraiment pas écrire toute cette documentation. Partager la collection de facteurs n'est pas une option.
J'ai récemment eu le même problème et je n'ai rien trouvé. J'ai donc créé un outil simple pour le faire. C'est une application javascript très basique écrite avec react.js. Pour l'instant, c'est très basique, mais je travaille dessus, donc toute demande de fonctionnalité est la bienvenue.
Vous pouvez l'utiliser gratuitement à: http://www.vernizzis.it/docman/
Plus, vous pouvez obtenir le code et le modifier à: https://github.com/davidevernizzi/docman
Tout commentaire est plus que bienvenue.
Update1: regarder autour J'ai aussi trouvé ce projet: https://github.com/JakeWorrell/docodile et cette demande de fonctionnalité: https://github.com/a85/POSTMan-Chrome-Extension/issues/204
MAJ2: la demande de fonctionnalité (voir Update1) a été fermé et la possibilité de créer la documentation a été ajoutée au nuage Postman . Voici le commentaire de fermeture de la demande de fonctionnalité:
Ceci est disponible dans le cadre de Postman Cloud: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/. Cloud héberge, met à jour et maintient la documentation pour tout le monde. Je suggère http://docman.launchrock.com/ et https://github.com/JakeWorrell/docodile pour générer une documentation unique à partir des collections.
Merde bon! Merci ... – mccbala
Vous êtes les bienvenus. Merci à toi. –
On dirait un super projet. Cependant, il est un peu ironique qu'un outil pour générer de la documentation n'a aucune documentation sur la façon de l'utiliser. Quand vous dites coller votre collection de postier, qu'est-ce que vous voulez dire exactement? – Chakaitos
Je sais que c'est une vieille question et vous avez probablement trouvé une solution maintenant, mais vous pourriez être intéressé par Postmanerator: https://github.com/aubm/postmanerator
En gros, voici comment vous l'utilisez de la ligne de commande:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
Pour l'installer, téléchargez la dernière version de Github. Vous devez choisir le binaire approprié en fonction de votre système. Puis placez-le quelque part dans votre PATH.
Voir la documentation dans le fichier README si vous souhaitez des informations supplémentaires. De là, vous trouverez des recommandations pour profiter pleinement de l'outil, ou changer l'apparence de votre documentation en utilisant des thèmes personnalisés.
La présentation Github fournit également une référence à une documentation d'exemple générée.
Vous découvrirez également comment tirer parti d'une plateforme CI comme Travis, pour automatiser la génération et la publication de votre documentation avec Postmanerator.
Comme il s'agit d'un projet open source sur lequel je travaille actuellement, n'hésitez pas à soumettre des questions sur Github si vous avez des idées qui peuvent l'améliorer.
Vous pouvez également essayer l'outil gratuit que j'ai fait. Il fournit la documentation au format .txt mais vous pouvez le convertir en pdf en utilisant votre navigateur.
Vous pouvez installer Newman en utilisant la commande « NPM installer -g Newman » et puis exécutez la commande « newman exécuter CollectionName.json -e envVar.json » de l'endroit où vous avez enregistré votre collection, où CollectionName.json est le nom de votre collection et enVar.json est l'ensemble des variables d'environnement. Cela générera un rapport html dans le même dossier. Une condition préalable est l'installation du noeud js.
Voici le mien, qui génère des fichiers '.md' via le script python https://github.com/Avinash-Raj/docs-from-POSTMAN –