Nice explaining there man, wondering is there any setting we can use to hide request parameter's values in the documentation, so we can not have actual values in the doc but only the detail about what user needs to send for that request?
When documenting APIs, does the Technical writer suppose to know the requests to add, or the developer provide the requests?, no one ever explained this point even videos for beginners, they just dig into how to document using a tool, and not how to get the info you'll need to document, can you please advise on this?
Yes, the APIs are developed by the tech team. These request bodies and end points are given by the tech team. Postman can help you list and test these APIs. But development is done by your tech team.
@@goyashy I take that as a technical writer when I document an API, I only explain the process and provide the requests and end points examples based on the dev input, correct?
Automate Content with Generative AI (Heavy Discount😱🚀): www.udemy.com/course/ai-content-generation/?couponCode=BESTPRICE
Very very thank u so much. I look for an hour but no document or any video can answer corectly like u
Glad this helps!
This is extremely helpful, thanks so much. I'm just starting to learn Postman, and this helps a lot!
Glad this helps!
Pretty simple and straight forward. Thank you.
We're glad this helps!
Subscribed
Many thanks!
Awesome, thank you for sharing this!
Fantastic
Great, thank you!
If we host documentation in custom domain then. It would be access by all ? Or only authorized person can access?
we can host, both private and public.
@@goyashy can you make an one video for that?
Nice explaining there man, wondering is there any setting we can use to hide request parameter's values in the documentation, so we can not have actual values in the doc but only the detail about what user needs to send for that request?
You'll have to look up man, no ready answers sorry
Take a look at how you can connect custom domains on Postman: ruclips.net/video/diSBO8ASRjI/видео.html
Consider subscribing! 🚀🚀
Thanks Yash!
Thank you so much
awesome thanks!
Thanks for sharing. Can i download the documentation?
I believe you can clone in postman, yes
Thanks
Welcome, please consider subscribing!
Thx man...
When documenting APIs, does the Technical writer suppose to know the requests to add, or the developer provide the requests?, no one ever explained this point even videos for beginners, they just dig into how to document using a tool, and not how to get the info you'll need to document, can you please advise on this?
Yes, the APIs are developed by the tech team. These request bodies and end points are given by the tech team.
Postman can help you list and test these APIs. But development is done by your tech team.
@@goyashy I take that as a technical writer when I document an API, I only explain the process and provide the requests and end points examples based on the dev input, correct?
@@jamesLucas-eg8hi yes, the job is to list out components given to you by the tech team. And explain what the components mean to your end customers.
@@goyashy Thank you so much for taking the time to answer my question, bless you for your help! cheers mate🙌
@@jamesLucas-eg8hi no worries!
awsm.
Thanks man !
Absolutely!
thank sir is very usefull
So glad this helps!
Could we incorporate basic authentication for accessing this documentation URL?
Think you'll have to take a look, I believe this is possible as well
thanks bahi
thanks
Glad this helps!
How to maintain version control?
Hey man, you'll have to look this up
How we can download this document?
Hi, it's not available anymore
Can we download this document
Hi, don't have access to any more
I think doing it this way is easier than using Swagger.
Yep, easier to maintain too!