Postman Documentation for Web Service

Introduction:

Postman is the complete toolchain for API developers. It supports every stage of API Lifecycle and in this blog, we will have a look on how a beautiful web-viewable document can be created. Postman’s API documentation feature lets you share public and private API documentation.

Pre-requisites:

1) Postman
2) Web service already created.

Steps to be followed:

Step 1:
Create the documentation from the-

• New Button
• Launch Screen

Step 2:
Click on Documentation tab.

Step 3:
You can create new API request or you can create document for existing collections. In this example we will cover for existing collections.

Step 4:
Tab where you can enter the description will be visible. In this tab we can write in Markdown language. This editor support Markdown language only. The syntax for writing it is simple and non-developer can also write it.

Markdown styling details can be found in below link. There are examples on styling with header, tables, links etc.

Markdown Styling

Step 5:
When all the styling is done, documentation link will be provided.

Step 6:
When you click on the link, your documentation will be visible. When you click on Publish, the link will be available publicly and you can share with your team members. Anyone with this link will be able to view the document and run web service requests.

When you click on Expand, complete request is visible. Same way responses can be added by saving an example

You can also go through the documentation provided by Postman. The link is given below:

https://www.getpostman.com/docs/v6/