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.82k stars 838 forks source link

Publish Documentation with Multiple Environments #4818

Open science695 opened 6 years ago

science695 commented 6 years ago

I am publishing documentation to a client of mine, and I want to be able to publish both a TESTING and PRODUCTION environment to the client so they have the relvant information about both environments.

When I look at the shared documentation, there is a dropdown that "could" hold more than one environment, but the publish dialog requires me to choose a single environment.

Could you update that publish dialog to allow you to publish multiple environments with a collection?

godfrzero commented 6 years ago

We'll see where we can get this added to the roadmap. I'll post updates here as they become available.

ghost commented 6 years ago

hey, this is a very important feature, in my work place we buy a licence pro, but we want publish our doc in multiple enviroments. https://api.epayco.co. I hope you fix this soon.

best regards.

mcataldo-gr8 commented 5 years ago

Any update on this improvement? This would be valuable for my organization as well.

carmenhchung-zz commented 5 years ago

Agreed with all the comments above - if we could have additional environments (we need testing and production, like the original poster) in the Postman documentation, that would be incredibly helpful! :)

krishofer commented 5 years ago

+1 on this!

vicker commented 5 years ago

+1

batshoes commented 5 years ago

+1 this would be great!

sankalp0o commented 5 years ago

Hi guys! Thanks for the feedback. Can I suggest you add reactions to the original issue instead of adding new comments? It ends up spamming the OP and others in the thread. Thanks!

So that I understand the problem better, why do you guys need multiple environments? I haven't seen a lot of public APIs with testing environments. Is that assumption incorrect? Are your clients looking for multiple environments while going through the documentation or while importing through the Run in Postman button? Is the API public or is it private?

carmenhchung-zz commented 5 years ago

Hi @sankalp0o, thanks for getting back to us!

We offer our partners the option of engaging with both testing and production environments for our public API in Postman through the "Run in Postman" button. As such, we'd like to offer both environments in our Postman documentation as well, so that the root domain can be automatically updated in the documentation to either production or testing, depending on which environment they are interested in using.

Let me know if further info would be helpful!

science695 commented 5 years ago

@sankalp0o Our use case is similar to what carmenhchung indicated.

We publish the docs for a collection to go to a client beginning with our testing environment, and when they are ready we switch it over to production. It would be much nicer if we could publish both testing and production environments. When I look at our docs (the private un-published versions), there are dropdowns for environments, which seems like it would be a great option to publish several environments and let the documentation be able to switch back and forth.

Perhaps publish multiple environments, and give a default environment option (so the page doesn't load without one).

Thanks!

sankalp0o commented 5 years ago

Thanks @carmenhchung and @science695 for providing detailed use cases. This really helps us understand the problem much better.

We will start discussing this and I will let you guys know when we have any updates.

radusw commented 5 years ago

My company needs this as well

DeanMauro commented 4 years ago

@sankalp0o, are there any updates to share on this feature?

mrtibs2000 commented 4 years ago

+1

mbacon-edocs commented 4 years ago

Slightly different use case, but hopefully same implementation - rather than just two (testing/live) we have the same API on multiple URLs based on the country you're calling from (as well as testing slots in each country). As such we want a single documentation page, and the ability for them to choose the country and then see what the full URL is for them (some of our partners/clients are based in multiple countries as well, so can't just give them 1 pre-built page).

TLDR: Hoping the implementation of this request will allow 2+ environments, not just picking a dev and a live env

pratikjain5 commented 4 years ago

Hey @sankalp0o @Raja-Simha Not sure what is the status on this issue. Its definitely use case for many companies to provide documentation for Sandbox and Production environments. In our company, we have to provide sandbox environment to our clients and would like to have environment selector on documentation page. It seems we can't publish two environments currently on postman

ncri commented 3 years ago

Any update here? We also need this. ;-)

shubhpy commented 3 years ago

Any update here in 2021?

cdolan92 commented 3 years ago

Disappointed this isn't an option. Without it, we have to share our staging baseURL in the documentation body or some other subpar answer.

mbraidy commented 3 years ago

This is a very useful feature. +1 from me This can serve both the documentation and the sandbox at the same time. A client can choose one environment to see our server API request url and chose another environment to see the sandbox request url.

stewartie4 commented 3 years ago

I managed to do this on the docs - I had multiple sets of environments in the dropdown but i can't figure out how i did it!

stewartie4 commented 3 years ago

never mind - because i was logged in, the postman docs ui is rendering my collections alongside the one published with the doc when in actual fact the collection is only published with a single collection - very very deceptive can't believe this is not a feature

fawcao commented 3 years ago

@sankalp0o any update about this?

sankalp0o commented 3 years ago

@Raja-Simha might be able to help here, I'm no longer involved in the project.

I'd suggest making a public workspace with your collections and multiple environments. This is not the exact thing being asked here, but has a couple of upsides

Hope this helps :)

steresi commented 3 years ago

@sankalp0o thanks for the advice here. A Public Workspace would let a client play around with your Collection within the Postman web UI (or I suppose the Postman app also).

However just to confirm... if you create a Public Workspace, say with two Environment Templates ("test" and "production"), that doesn't actually affect the generated documentation page, though, right? The documentation page will still only have one option in the dropdown ("No Environment", plus whatever Environment Template you selected when publishing)!

hueldera commented 2 years ago

+1

cherryramatisdev commented 2 years ago

+1

aharasta commented 2 years ago

Kinda frustrating to not be able to even manually toggle the environments in the app for a set of customers that might be onboarding into a staging environment instead of production. Sharing a public collection is not ideal if we just want to share information publicly without asking customers to familiarize themselves with a new product. @Raja-Simha Where is this on the roadmap?

msshahanshah commented 2 years ago

This would be a really helpful feature, can't understand why this has not been implemented since the original request is from 2018!!

annoyedcust commented 2 years ago

Even though it's already a dropdown in the UI, I'm beginning to believe we will never see this option made available.

Want to publish a Prod and a Test environment? No problem. Publish each on a different "custom domain." Why? So they can charge you $10/mo for each extra one.

It would be better if they would just be honest with us. Tell us to buy more domains, and close out the ticket.

nickjuntilla commented 2 years ago

Wow this is crazy. This is something that almost all api documentation does. It even looks like it's going to work and then doesn't. How is such a basic feature missing?

lougeo commented 2 years ago

I would also like to see this functionality - there's already a dropdown that can switch between 'No Environment' and the added environment... doesn't seem like a stretch.

Ikdemm commented 2 years ago

We would love to have this feature as well. Is there a way we can help you regarding this?

MathieuBurnat commented 2 years ago

I still believe. :]

raghuchinnannan commented 2 years ago

Is there an update on this? We have 2 different hosts for US & EU data center and we don't want to publish 2 different API documentation. Environment would be ideal.

adnenbe commented 2 years ago

Interresting and required feature, any update on this @postman-support please ?

venkatrao225 commented 1 year ago

@postman-support We are also running into the same issue, any timelines for the fix?

DePalmo commented 1 year ago

The request is four years old (at the time of writing this comment) and this still wasn't added? Wow, just wow.

So next question. Despite I like Postman, this is rather a big issue since I need to post or forward two sets of URLs, which should obviously not be needed: what's the alternative of Postman?

venkatrao225 commented 1 year ago

@akshaydeo @Raja-Simha could you plz check this conversation and provide us the latest status on this?

sharapov-outsource commented 1 year ago

@postman-support do you forget about this? Any update on this? Would be very helpful for us.

valentim-guilherme commented 1 year ago

Really? until today not developed?

saharc8 commented 1 year ago

still not developed! please @postman-staff

attack-monkey commented 11 months ago

Would really love to see this developed.

julienhauspie commented 11 months ago

Crazy to see that 5 years later this feature is still not present in Postman. @postman-staff @Raja-Simha

jayomayan commented 9 months ago

any update on this basically the Environment in Documentation is kinda useless if we can only publish one environment at a time.

schengawegga commented 6 months ago

We need this as well. Crazy to see, that there is an dropdown in the published documentation already ;-)

richarddwelsh commented 6 months ago

@postman-staff Any update on this? Why have a pull-down menu in the published docs if you can only ever have one environment at a time?

mahdizojaji commented 5 months ago

I need this feature too

AjatshatruSingh commented 3 weeks ago

@akshaydeo @Raja-Simha : We need this feature as well. And have been waiting for it for quite a while. Please let us know if this is even in the pipeline anymore. We will plan our usage accordingly.