This talk was presented at API The Docs Virtual 2021 event series on 13 July. We are glad to present the video recording, slide deck and talk summary below. Enjoy!
Visit our talk recaps ToC page for an overview of all presentations!
How to make your Postman API documentation more interactive and informative? How can you visualize complex objects in Postman and improve your documentation process? The Postman Hackathon winner, Carson Hunter tells a story about how she and her colleague won the challenge and what documentation tools they developed on the way.
The idea: Let’s build a public workspace where developers could go with their collection they’re already started working on, and they could amp up their documentation in different ways.
The Docu-mentor project consists of two parts:
Adds OpenAPI-esque models to Postman documentation by:
Users now have an automatically generated thorough reference for every request and response of the API:
All the object models are getting listed in a separate folder on the left navigation in Postman
The representation of the model is displayed on the right with the:
The only manual step you need to do is to provide the description after the main content and structure of the documentation are automatically generated.
Like a code coverage report, but for documentation.
The algorithm is built inside Postman request scripts, and the reports can be displayed on Slack.