A simple way to document your API with postman

Ayooluwa Oyewo
Aug 31, 2019 · 3 min read

Usually, when working on a team of developers as a backend developer there is a need to provide a succinct documentation of the API you just developed, as much as there are lots of documentation options I found using postman documentation quite easy, stressless, and fast.

Before you start using Postman to test your API endpoints, I will advise you to create a collection for your API endpoints. You can do that by clicking the collection tab on your postman app, fill in the details required into the dialog box, then create the collection like so:-

Collection Tab

After creation, you can begin to add your requests to your collection like so:-

Add A Request
Add A Request
Add Request to Collection

You can then begin to test your API endpoints.

I am going to use an example here, I have a server running already and an endpoint that signs in a user

http://localhost:3000/api/v1/users/signin/

After getting the required response click on the save buttons adjacent the send button and download button in order to save your endpoint, request body and response like so:-

You can then go back to your collection and generate your documentation by clicking the < button adjacent the collection, then click view in web button on the dialog box like so:

Generate Documentation

You will notice a new browser window open up like so:-

Generated Documentation

This shows your endpoint, request body and response example. You can share this documentation by generating a unique public link by clicking the publish button on the upper right corner of the page like so:-

Publish

You can then copy and share the PUBLISHED URL with anyone that needs the API documentation.

Here is the one I just generated Example Collection.

If you understood and enjoyed this post or you have comments, do well to let me know.

Thanks for reading.

Data Driven Investor

from confusion to clarity not insanity

Ayooluwa Oyewo

Written by

Full-Stack Developer | Python(Django and Django Rest Framework) | JavaScript(Angular, ReactJs, NodeJs, ExpressJs) | Tech Community Builder | Committed Learner

Data Driven Investor

from confusion to clarity not insanity

More From Medium

More from Data Driven Investor

More from Data Driven Investor

More from Data Driven Investor

More from Data Driven Investor

PowerPoint: The Most Underrated Diagram Tool

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade