18

I've developed a pretty extense API, and I have it on Postman, which works pretty nice. Now I have to generate an html doc to keep it versioned inside /docs along with my sources.

Is there a tool or a way to achieve this? I really don't want to write all this documentation.I don't want to use Postman publish docs also. Sharing the postman collection is not an option How can we convert Postman Collection to PDF/Word document?

Grokify
  • 15,092
  • 6
  • 60
  • 81
Nikita
  • 328
  • 1
  • 2
  • 10

4 Answers4

13

You can publish the documentation of your collection through postman :

  1. Click on the ... -> Publish Docs.

enter image description here

This will open a new page to postman website in which you can preview your documentationenter image description here.

  1. Click on Preview Documentation, it will open a new page as the html version of the documentation.

  2. Right click to display chrome option Print it enter image description here

This will provide you the option to save it as a pdf

enter image description here

This answer was inspired from here for Creating html doc from postman collection.

user1223339
  • 193
  • 2
  • 9
  • 1
    Thanks for response. I have tried https://stackoverflow.com/questions/29238120/creating-html-doc-from-postman-collection but not find any proper solution. – Nikita Oct 31 '17 at 06:38
  • @PrabhjotSinghKainth; My answer it may be not enough detailed but it wasn't wrong. I have edited it to proof it validity. – user1223339 Feb 19 '20 at 10:58
  • Note, In a more recent version, you must be registered and have access to a workspace. From the Workspace follow the steps in this post, except select 'View Documentation" -> "Publish" instead. – SeesSound May 03 '21 at 07:13
5

The best I've found is Postman to HTML (properly, not file > save)

  1. Install this anywhere in your PATH: https://github.com/aubm/postmanerator
  2. Right click on your collection in Postman and click export, which will give you a JSON file
  3. Run postmanerator -output=/var/www/public/api.html -collection=/var/www/my-collection.json in cli

You can create your own themes too which collectively is what we all want to be able to do straight out of Postman

zanderwar
  • 3,440
  • 3
  • 28
  • 46
0

For newer versions of postman try this

  1. Go to your collection
  2. Right click the collection and go to "View Documentation"
  3. Then top right hand corner, press "Publish"

enter image description here

Ruan
  • 3,969
  • 10
  • 60
  • 87
-3

You can also get the PDF version by clicking :

enter image description here

Eran
  • 1,628
  • 16
  • 31