How to generate your API documentation with Postman in 20 minutes

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…