Ich habe eine ziemlich umfangreiche API entwickelt, und ich habe es auf Postman, die ziemlich gut funktioniert. Jetzt muss ich ein HTML-Dokument erstellen, um es versioniert in/Docs zusammen mit meinen Quellen zu behalten.Erstellen von HTML-Dokument aus Postbote Sammlung
Gibt es ein Werkzeug oder einen Weg, dies zu erreichen? Ich möchte wirklich nicht diese ganze Dokumentation schreiben. Das Teilen der Postboten-Sammlung ist keine Option.
Ich hatte vor kurzem das gleiche Problem und ich habe nichts gefunden. Also habe ich ein einfaches Tool dafür erstellt. Es ist eine sehr einfache Javascript-Anwendung geschrieben mit react.js. Im Moment ist es sehr einfach, aber ich arbeite daran, so dass jede Feature-Anfrage willkommen ist.
Sie können es kostenlos verwenden unter: http://www.vernizzis.it/docman/
plus Sie den Code erhalten können und ändern Sie es an: https://github.com/davidevernizzi/docman
Jeder Kommentar ist mehr als willkommen.
UPDATE1: umsah auch ich dieses Projekt gefunden: https://github.com/JakeWorrell/docodile und dieses Feature Anfrage: https://github.com/a85/POSTMan-Chrome-Extension/issues/204
UPDATE2: der Feature-Request (siehe UPDATE1) geschlossen wurde und die Möglichkeit Dokumentation zu schaffen hat Postman Cloud hinzugefügt . Hier ist der Kommentar zum Abschluss der Feature-Anforderung:
Dies ist als Teil von Postman Cloud: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/. Cloud hostet, aktualisiert und pflegt die Dokumentation für alle. Ich würde vorschlagen, http://docman.launchrock.com/ und https://github.com/JakeWorrell/docodile für die Generierung von einmaligen Dokumentation von Sammlungen.
Verdammt gut! Danke ... – mccbala
Sie sind herzlich willkommen. Danke dir. –
Sieht aus wie ein großartiges Projekt. Es ist jedoch ein wenig ironisch, dass ein Werkzeug zum Erstellen von Dokumentationen keine Dokumentation darüber hat, wie man es benutzt. Wenn Sie sagen, fügen Sie Ihre Postboten-Sammlung was genau meinst du? – Chakaitos
Ich weiß, dass dies eine alte Frage ist und Sie wahrscheinlich eine Lösung jetzt gefunden, aber immer noch können Sie durch Postmanerator interessieren: https://github.com/aubm/postmanerator
Im Grunde ist dies, wie Sie es von der Befehlszeile verwenden:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
Um es installiert zu bekommen, laden Sie die neueste Github-Version herunter. Sie müssen die entsprechende Binärdatei abhängig von Ihrem System auswählen. Dann lege es irgendwo in deinen PFAD.
Weitere Informationen finden Sie in der Dokumentation in der README. Von hier aus finden Sie Empfehlungen, wie Sie das Tool vollständig nutzen oder das Aussehen Ihrer Dokumentation mithilfe von benutzerdefinierten Designs ändern können.
Die Github-Präsentation bietet auch einen Verweis auf eine generierte Beispieldokumentation.
Sie werden auch erfahren, wie Sie eine CI-Plattform wie Travis nutzen können, um die Erstellung und Veröffentlichung Ihrer Dokumentation mit Postmanerator zu automatisieren.
Da es sich um ein Open-Source-Projekt handelt, an dem ich gerade arbeite, können Sie Probleme auf Github stellen, wenn Sie Ideen haben, die es besser machen.
Sie können auch das kostenlose Tool, das ich gemacht habe, ausprobieren. Es stellt die Dokumentation in .txt zur Verfügung, aber Sie können es mit Ihrem Browser in PDF konvertieren.
Sie können Newman Befehl installieren „npm Newman installieren -g“ und dann den Befehl „newman laufen CollectionName.json -e envVar.json“ laufen von dem Ort, an dem Sie Ihre Sammlung gespeichert haben, wo CollectionName.json ist der Name Ihrer Sammlung und enVar.json ist die Menge der Umgebungsvariablen. Dies erzeugt einen HTML-Bericht im selben Ordner. Eine Voraussetzung ist, dass Knoten js installiert ist.
Hier ist meine, die '.md' Dateien über Python-Skript generiert https://github.com/Avinash-Raj/docs-from-POSTMAN –