How to generate your API documentation with Postman in 20 minutes

Olotin Temitope
3 min readMar 1, 2018

Developers sometimes spend a couple of weeks building an API and maybe another week writing the documentation, and this can be time-consuming. The question is, is it possible to generate API documentation in 20 minutes? Yes, it is possible and we are going to learn how to do that now.

Apparently, Postman is the most commonly used REST Client for testing API endpoints, but most people don’t realize that it can be used to generate well-formatted documentation. In this tutorial, we are going to expose a simple trick on how to leverage Postman to ease the stress of generating documentation.

I will not be covering how to build an API in this tutorial; I want to assume that you already have existing API endpoints.

Shall we begin the magic?

https://giphy.com/gifs/12NUbkX6p4xOO4/html5

Creating a documentation

Leveraging your existing requests to generate the documentation

If you have already tested your endpoints on Postman then congratulations, all you have to do now is to go back to the requests and add them to a collection.

What’s a POSTMAN collection

Postman collection allows you to save your requests in such a way that they can be reused and shared anytime. It also allows you to group your requests so that each API resource can act like a folder where you can save similar endpoints.

Let’s add our existing requests to a collection.

Create a new collection or add to the existing one.

How to add your existing requests to a collection.

  1. On your existing request window hold command + S keys
  2. Click on create a collection
  3. Add your preferred name
  4. Hit save button

After completing the above steps, you now have a collection which you can further add your requests. Immediately you create a new collection it appears on the collection tab.

--

--

Olotin Temitope

Software Developer @andela | Music Lover | Data Science Enthusiast.