Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Convert Postman Collection to PDF

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?

like image 492
Nikita Avatar asked Oct 27 '17 12:10

Nikita


People also ask

How to create HTML DOC from Postman collection?

Click on the ... -> Publish Docs. This will open a new page to postman website in which you can preview your documentation. Click on Preview Documentation, it will open a new page as the html version of the documentation. This answer was inspired from here for Creating html doc from postman collection.

How to export postman collection in Excel?

However, it is critical to remember that postman collection is usually exported in JSON format for easier sharing. 1.1 1. Select the collection you want to export 1.2 2. Click on the ellipsis (…) button to open the options menu. 1.3 3. Choose the recommended version to export 1.4 4.

How to convert postman2doc to HTML&DOCX?

OR you can run postman2doc directly, then you will see the command I/O. If you want convert to html & docx document, use following command. If convert success, you will receive a system notification, then you can see the document file at same folder. Convert postman collection.json to...

What is Postman’s open technologies approach?

Allowing teams to produce OpenAPI from existing APIs or the APIs they have mocked as a collection, making it easier to be API-first without necessarily being API design first. This is the Postman Open Technologies approach to platform governance.


2 Answers

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.

like image 127
user1223339 Avatar answered Sep 20 '22 14:09

user1223339


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

like image 36
zanderwar Avatar answered Sep 21 '22 14:09

zanderwar