{"id":742,"date":"2020-07-24T15:30:45","date_gmt":"2020-07-24T15:30:45","guid":{"rendered":"https:\/\/www.dhruvsoft.com\/blog\/?p=742"},"modified":"2024-07-26T09:40:43","modified_gmt":"2024-07-26T09:40:43","slug":"using-postman-for-api-documentation","status":"publish","type":"post","link":"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/","title":{"rendered":"Using Postman for API Documentation"},"content":{"rendered":"\n<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_83 ez-toc-wrap-left-text counter-hierarchy ez-toc-counter ez-toc-grey ez-toc-container-direction\">\n<div class=\"ez-toc-title-container\">\n<p class=\"ez-toc-title\" style=\"cursor:inherit\">Table of Contents<\/p>\n<span class=\"ez-toc-title-toggle\"><a href=\"#\" class=\"ez-toc-pull-right ez-toc-btn ez-toc-btn-xs ez-toc-btn-default ez-toc-toggle\" aria-label=\"Toggle Table of Content\"><span class=\"ez-toc-js-icon-con\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/span><\/a><\/span><\/div>\n<nav><ul class='ez-toc-list ez-toc-list-level-1 eztoc-toggle-hide-by-default' ><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#What_is_Postman\" >What is Postman?<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Features_and_Pricing\" >Features and Pricing<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Why_do_we_need_Postman_documentation\" >Why do we need Postman documentation?<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Business_scenario\" >Business scenario<\/a><ul class='ez-toc-list-level-4' ><li class='ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-5\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Step_1_%E2%80%93_Creating_a_sample_collection\" >Step 1 &#8211; Creating a sample collection<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-6\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Step_2_%E2%80%93_Adding_requests\" >Step 2 &#8211; Adding requests<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-7\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Step_3_%E2%80%93_Publishing_Docs\" >Step 3 &#8211; Publishing Docs<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-8\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Step_4_%E2%80%93_Document_Overview\" >Step 4 &#8211; Document Overview&nbsp;<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-4'><a class=\"ez-toc-link ez-toc-heading-9\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Step_5_%E2%80%93_Adding_Custom_Domain_to_the_generated_URL\" >Step 5 &#8211; Adding Custom Domain to the generated URL&nbsp;<\/a><\/li><\/ul><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-10\" href=\"https:\/\/www.dhruvsoft.com\/blog\/using-postman-for-api-documentation\/#Conclusion\" >Conclusion<\/a><\/li><\/ul><\/nav><\/div>\n<h3 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"What_is_Postman\"><\/span>What is Postman?<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Postman is a tool used to test, develop, and modify APIs. Also, it provides API monitoring and documentation. It&#8217;s widely used by most of the enterprise and software product companies.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">We can use <strong>Postman collections<\/strong> to share between different environments and to perform API assertion testing.&nbsp;<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1000\" height=\"417\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Using-Postman-for-API-Documentation.jpg\" alt=\"Using Postman for API Documentation\" class=\"wp-image-752\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Using-Postman-for-API-Documentation.jpg 1000w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Using-Postman-for-API-Documentation-300x125.jpg 300w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Using-Postman-for-API-Documentation-768x320.jpg 768w\" sizes=\"auto, (max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<!--more-->\n\n\n\n<h3 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Features_and_Pricing\"><\/span>Features and Pricing<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Following are features of Postman<\/p>\n\n\n\n<ol class=\"wp-block-list\"><li>Design, develop, and test APIs<\/li><li>Collaborating with your team<\/li><li>Manage the API workflow in one place<\/li><\/ol>\n\n\n\n<p class=\"wp-block-paragraph\">There are three types of pricing plans. Recently they have removed the free plan which was very popular among integration developers.&nbsp;<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"676\" height=\"330\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Postman-API-pricing.jpg\" alt=\"Postman API integration pricing\" class=\"wp-image-743\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Postman-API-pricing.jpg 676w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Postman-API-pricing-300x146.jpg 300w\" sizes=\"auto, (max-width: 676px) 100vw, 676px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Why_do_we_need_Postman_documentation\"><\/span>Why do we need Postman documentation?<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">It offers well organized, structured, and beautiful documentation. Without spending much time on design, it can generate from the API collection, which we used for extensive testing.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">It provides a secured URL to access publicly, and from that, users can Import and run those cases directly in the Postman tool.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Business_scenario\"><\/span>Business scenario<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Let&#8217;s take an example; your company has asked you to create documentation and share it publicly. Also, it would help if you created REST API test cases. In this post, we will explain this step by step-<\/p>\n\n\n\n<h4 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Step_1_%E2%80%93_Creating_a_sample_collection\"><\/span>Step 1 &#8211; Creating a sample collection<span class=\"ez-toc-section-end\"><\/span><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">Create a collection with the required information about your API. Postman accepts Markdown text formatting to beautify content.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"660\" height=\"344\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Creating-a-sample-collection.jpg\" alt=\"Postman API - Creating a sample collection\" class=\"wp-image-744\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Creating-a-sample-collection.jpg 660w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Creating-a-sample-collection-300x156.jpg 300w\" sizes=\"auto, (max-width: 660px) 100vw, 660px\" \/><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Step_2_%E2%80%93_Adding_requests\"><\/span>Step 2 &#8211; Adding requests<span class=\"ez-toc-section-end\"><\/span><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">Add a request under the created collection and save the appropriate response.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"668\" height=\"380\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Adding-requests.jpg\" alt=\"Postman API Add a request\" class=\"wp-image-745\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Adding-requests.jpg 668w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Adding-requests-300x171.jpg 300w\" sizes=\"auto, (max-width: 668px) 100vw, 668px\" \/><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Step_3_%E2%80%93_Publishing_Docs\"><\/span>Step 3 &#8211; Publishing Docs<span class=\"ez-toc-section-end\"><\/span><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">Publish docs using collection settings, as shown in the below Image.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"642\" height=\"437\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Publishing-Docs.jpg\" alt=\"Postman API Publishing Docs\" class=\"wp-image-746\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Publishing-Docs.jpg 642w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Publishing-Docs-300x204.jpg 300w\" sizes=\"auto, (max-width: 642px) 100vw, 642px\" \/><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">After publishing the collection, you will get a URL to access, as shown below.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"623\" height=\"378\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/get-a-URL-to-access.jpg\" alt=\"Public documentation lik\" class=\"wp-image-747\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/get-a-URL-to-access.jpg 623w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/get-a-URL-to-access-300x182.jpg 300w\" sizes=\"auto, (max-width: 623px) 100vw, 623px\" \/><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Step_4_%E2%80%93_Document_Overview\"><\/span>Step 4 &#8211; Document Overview&nbsp;<span class=\"ez-toc-section-end\"><\/span><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">Users can set the preferred language for requests. In the documentation, the request&#8217;s saved responses will be shown right-hand side and required headers and body shown left-hand side. They can import from the &#8220;Run In Postman&#8221; button.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"665\" height=\"374\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Document-Overview.jpg\" alt=\"Postman API Document overview\" class=\"wp-image-748\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Document-Overview.jpg 665w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Document-Overview-300x169.jpg 300w\" sizes=\"auto, (max-width: 665px) 100vw, 665px\" \/><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Step_5_%E2%80%93_Adding_Custom_Domain_to_the_generated_URL\"><\/span>Step 5 &#8211; Adding Custom Domain to the generated URL&nbsp;<span class=\"ez-toc-section-end\"><\/span><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">To set up a custom domain, customers need a subscription. Follow the below screenshots to add a custom domain.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"678\" height=\"167\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Adding-Custom-Domain.jpg\" alt=\"Postman API custom domain\" class=\"wp-image-749\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Adding-Custom-Domain.jpg 678w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/Adding-Custom-Domain-300x74.jpg 300w\" sizes=\"auto, (max-width: 678px) 100vw, 678px\" \/><\/figure>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"422\" height=\"504\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/domain-veryfication.jpg\" alt=\"verify custom domain\" class=\"wp-image-750\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/domain-veryfication.jpg 422w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/domain-veryfication-251x300.jpg 251w\" sizes=\"auto, (max-width: 422px) 100vw, 422px\" \/><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">You can select a custom domain while publishing docs, as shown below.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"631\" height=\"421\" src=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/select-a-custom-domain-while-publishing.jpg\" alt=\"how to add custom domain \" class=\"wp-image-751\" srcset=\"https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/select-a-custom-domain-while-publishing.jpg 631w, https:\/\/www.dhruvsoft.com\/blog\/wp-content\/uploads\/2020\/07\/select-a-custom-domain-while-publishing-300x200.jpg 300w\" sizes=\"auto, (max-width: 631px) 100vw, 631px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Conclusion\"><\/span>Conclusion<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">API Documentation provides a perfect guide to access APIs. People spend a lot of time designing and updating on this. Postman is one of the best solutions to generate it by simple few clicks.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n","protected":false},"excerpt":{"rendered":"<p>What is Postman? Postman is a tool used to test, develop, and modify APIs. Also, it provides API monitoring and documentation. It&#8217;s widely used by most of the enterprise and software product companies. We can use Postman collections to share between different environments and to perform API assertion testing.&nbsp;<\/p>\n","protected":false},"author":26,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[119],"tags":[],"class_list":["post-742","post","type-post","status-publish","format-standard","hentry","category-integration","entry"],"_links":{"self":[{"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/posts\/742","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/users\/26"}],"replies":[{"embeddable":true,"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/comments?post=742"}],"version-history":[{"count":0,"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/posts\/742\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/media?parent=742"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/categories?post=742"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.dhruvsoft.com\/blog\/wp-json\/wp\/v2\/tags?post=742"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}