postmanlabs / postman-app-support

Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
https://www.postman.com
5.84k stars 839 forks source link

Export/Download API Documentation #3438

Closed aswope closed 1 year ago

aswope commented 7 years ago

Issue Report:

The new API documentation feature is coming along nicely! (Hopefully parameters will be added quite soon.)

HOWEVER, the main issue preventing me from taking the team to Postman and its Documentor is the reliance on always serving documentation from Postman's servers. I have to be able to deliver offline documentation to my customers. (This can be in HTML, doc, or PDF format.)

I've been emailing Claire Riley regarding this, and she requested that I open an Issue. It appears that Swagger's documentation feature is capable of doing this, but I REALLY DO NOT want to move our API workflow to using Swagger.

Alternative: Add a feature to produce API blueprint files that are compatible with Aglio or other similar blueprint-based documentor.

Xdomen commented 2 years ago

This feature would help us a lot 🙏

oscarguinane commented 2 years ago

Common guys, let's get this done, it's been nearly 5 years now.

ctrlsam commented 2 years ago

Another solution if you just want HTML documentation

1) Export postman JSON 2) Convert JSON to Swagger YAML here 3) Paste YAML result into Swagger editor 4) Export to Swagger JSON (File -> Convert and save to JSON) 5) Install redoc npm install -g redoc-cli 6) Create html redoc-cli bundle -o index.html <YOUR JSON>

Famosi commented 2 years ago

Will this feature be implemented? Is it in the todo list?

ARedmanDodd commented 2 years ago

Just adding my support for this feature. I have a client that requires offline PDF documentation and I am currently searching for a way to work around this.

NaumanMoazzamKhired commented 1 year ago

It's almost 5 years, do we have any update on this?

I would like to export this Documentation and add this to GitHub Readme.

grantm009 commented 1 year ago

I think it is most unlikely that this will be implemented. Having the documentation locked in means the customer is locked in. I have been asking for this for years and it just gets ignored :). Thats why we don't use postman for any work other than testing/building APIs.

On Mon, 14 Nov 2022 at 21:30, Nauman Moazzam @.***> wrote:

It's almost 5 years, do we have any update on this?

I would like to export this Documentation and add this to GitHub Readme.

— Reply to this email directly, view it on GitHub https://github.com/postmanlabs/postman-app-support/issues/3438#issuecomment-1313446596, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG5KOGHOPBUF4YIKA62NE3DWIIIF7ANCNFSM4DYCMJXQ . You are receiving this because you commented.Message ID: @.***>

shankar-bavan commented 1 year ago

+1

preethammavin commented 1 year ago

Hey, this is not on the current roadmap. If you need to, you can print the documentation to generate the PDF. We will open the thread again if we pick this up.