Upgrade Your Collections
summary
Practical, repeatable steps to make Postman collections usable and shareable: a submission template to standardize collection and request-level docs, automated example generation via the mtna newman utility to save time, and guidance to include concrete tech notes (auth, throttling, provenance) plus screenshots or GIFs because built visualizations don’t appear in HTML docs. Also a working demo using a Cheerio.js scraper with the Postman API to turn TSA HTML tables into JSON, which earned a Resource Center listing and collaboration with Postman.
AI-written summary · about
chapters (6)
- 0:00Intro
- 1:15Who benefits from good docs?
- 3:40Postman Public Workspaces & API Resource Centers
- 6:59Collection-Level Context
- 10:17Example Responses
- 12:32Utility Requests Flex your JavaScript muscles
related talks
48mBeyond Words: Crafting User-Friendly Documentation
57mDocumenting RESTful APIs with Spring REST Docs
35mDocumenting APIs: new era, same craft
33mDocumentation: The Missing Pieces
46mSave a Dev, Write Documentation!
49mExplain Yourself! Documentation for Better Code
30mTechnical Documentation
29mTaking Stock of Your Documentation