How to document your API with Postman
API documentation is a quick and concise technical document that contains information on how to effectively use an API
Developers are expected to spend quality time to write detailed documentation for the APIs they create because good APIs are the ones that have sufficient documentation.
One of the easiest to create documentation for your API is by using Postman. It’s very easy to use, all you need is to have Postman installed on your PC.
Steps to document your API with Postman
Having installed Postman on your PC, create an account on Postman, create a new collection on Postman
Click on Collections
Click on New Collection
A popup screen will appear
Input the name of the Collection
Input the description of the collection
Click on the Create
Click on the three dots on your collection name
A popup window appears, click on Add Request to add an endpoint
Add the Request name (a descriptive name for your endpoint)
Add the description (optional)
Click on Save to Jokes API (collection name)
Add the endpoint
Click on Send to test the endpoint
Click on Save to save the request because of the changes added to it
Click on the three dots on your collection name
Click on the Publish Docs, It opens a webpage where you can publish your collection
Click on Publish Collection and you’ve access to the URL that you can share with anyone.
When you click on your URL, it should look like the screenshot below
Happy documenting!!!!
