{"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

What is Postman?<\/h3>\n\n\n\n

Postman is a tool used to test, develop, and modify APIs. Also, it provides API monitoring and documentation. It’s widely used by most of the enterprise and software product companies.<\/p>\n\n\n\n

We can use Postman collections<\/strong> to share between different environments and to perform API assertion testing. <\/p>\n\n\n\n

\"Using<\/figure>\n\n\n\n\n\n\n\n

Features and Pricing<\/h3>\n\n\n\n

Following are features of Postman<\/p>\n\n\n\n

  1. Design, develop, and test APIs<\/li>
  2. Collaborating with your team<\/li>
  3. Manage the API workflow in one place<\/li><\/ol>\n\n\n\n

    There are three types of pricing plans. Recently they have removed the free plan which was very popular among integration developers. <\/p>\n\n\n\n

    \"Postman<\/figure>\n\n\n\n

    Why do we need Postman documentation?<\/h3>\n\n\n\n

    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

    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

    Business scenario<\/h3>\n\n\n\n

    Let’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

    Step 1 – Creating a sample collection<\/h4>\n\n\n\n

    Create a collection with the required information about your API. Postman accepts Markdown text formatting to beautify content.<\/p>\n\n\n\n

    \"Postman<\/figure>\n\n\n\n

    Step 2 – Adding requests<\/h4>\n\n\n\n

    Add a request under the created collection and save the appropriate response.<\/p>\n\n\n\n

    \"Postman<\/figure>\n\n\n\n

    Step 3 – Publishing Docs<\/h4>\n\n\n\n

    Publish docs using collection settings, as shown in the below Image.<\/p>\n\n\n\n

    \"Postman<\/figure>\n\n\n\n

    After publishing the collection, you will get a URL to access, as shown below.<\/p>\n\n\n\n

    \"Public<\/figure>\n\n\n\n

    Step 4 – Document Overview <\/h4>\n\n\n\n

    Users can set the preferred language for requests. In the documentation, the request’s saved responses will be shown right-hand side and required headers and body shown left-hand side. They can import from the “Run In Postman” button.<\/p>\n\n\n\n

    \"Postman<\/figure>\n\n\n\n

    Step 5 – Adding Custom Domain to the generated URL <\/h4>\n\n\n\n

    To set up a custom domain, customers need a subscription. Follow the below screenshots to add a custom domain.<\/p>\n\n\n\n

    \"Postman<\/figure>\n\n\n\n
    \"verify<\/figure>\n\n\n\n

    You can select a custom domain while publishing docs, as shown below.<\/p>\n\n\n\n

    \"how<\/figure>\n\n\n\n

    Conclusion<\/h3>\n\n\n\n

    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>\n","protected":false},"excerpt":{"rendered":"

    What is Postman? Postman is a tool used to test, develop, and modify APIs. Also, it provides API monitoring and documentation. It’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. <\/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}]}}