Création d'un document HTML à partir de la collection Postman
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.
Existe-t-il un outil ou un moyen d'y parvenir? Je ne veux vraiment pas écrire toute cette documentation. Le partage de la collection de facteur 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. Il s'agit d'une application javascript très basique écrite avec react.js. Pour le moment, il est très basique, mais j'y travaille, donc toute demande de fonctionnalité est la bienvenue.
Vous pouvez l'utiliser gratuitement sur: http://www.vernizzis.it/docman/
De plus, vous pouvez obtenir le code et le modifier à: https://github.com/davidevernizzi/docman
Tout commentaire est plus que bienvenu.
UPDATE1: en regardant autour, j'ai également trouvé ce projet: https://github.com/JakeWorrell/docodile et cette demande de fonctionnalité: https://github.com/a85/POSTMan-Chrome -Extension/problèmes/204
UPDATE2: la demande de fonctionnalité (voir UPDATE1) a été fermée et la possibilité de créer de la documentation a été ajoutée au cloud Postman. Voici le commentaire de clôture 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.
Je sais que c'est une vieille question et vous avez probablement déjà trouvé une solution, mais vous pourriez toujours être intéressé par Postmanerator: https://github.com/aubm/postmanerator
Fondamentalement, voici comment vous l'utilisez à partir 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. Ensuite, placez-le quelque part dans votre CHEMIN.
Consultez la documentation dans le README si vous voulez 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 à un exemple de documentation 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 problèmes sur Github si vous avez des idées qui peuvent l'améliorer.