Hey, want to learn how to make API doc in Postman, then you are at right place !!
Let's start building the doc without reading more introductory lines....
1. What do you mean by collection??
Collection means listing/assembling/grouping of all the API's and this collection with style formatting, published url and some customisation is called API doc.
2. What is API doc??
API doc is basically the collection of all API's of the the project which you are working on. It consists of body,response,status, description and much more depends on the requirement. In simple terms, collection with style formatting, published url and some customisation is called API doc.
3. Why to make API doc??
- to make proper listing of all the API's so that front end developers can make use of it to know which API needs which parameters to pass along with response, description, status and more
- helps to understand the project in much more easy way
4. What is Postman??
Postman is an API(application programming interface) development tool which helps to build, test and modify APIs. Through Postman, we can create collection and make our API's saved in it and then publish it with some customisation to make our API doc.
5. How to make API doc in Postman??
Follow these steps to make your API doc:
- create your account on postman and then sign in
- as said above, we have to make collection in postman, then that collection we will publish which is our API doc, so click on New or + to create collection
- after collection is created, then click on Save and then select your collection to add your API's to this collection which you have to show in your doc
- then click on three dots shown ... and select View documentation
- then you will see the below page, after that click on Publish to publish your collection to make API doc
- after that, you will be redirected to the browser where you can customise your collection like adding styles in it etc. on that page, scroll down to bottom, you will see the Publish Collection button, click on it to publish your collection
- after publishing the doc, you will get the url of the API doc which you can share to anyone so that anyone can see your API's
If you like this article, Please like, share and comment..
