Postman Intergalactic | API Publishers Series, Part 1: Introduction to Documentation

Link to example collection

Join us for a one-hour, introductory Postman learning session geared specifically for API publishers. We’ll walk you through popular Postman features like workspaces and Postman’s API documentation tool while we discuss how to craft a strong developer experience.

Here’s what we’ll do in this session:
- Explain how documentation influences user onboarding
- Create API reference and workflow guides
- Publish a public workspace for community collaboration
- Share documentation in the Postman API Network and via the "Run in Postman" button icon button

0:00 Introduction and agenda
6:43 What is an API publisher
10:00 Obstacles to Consuming APIs
12:08 Import an OpenAPI specification (OAS)
17:50 Generate documentation from OAS
22:00 Add markdown descriptions
25:50 Optimize for onboarding with workflows (use cases)
26:30 Create a collection from scratch starting with Authorization
30:00 Use variables
33:15 Update visibility of workspace for Personal, Team, or Public
34:30 Share documentation in Public API Network
37:14 Generate Run in Postman button
40:50 Fork a collection
43:50 Recap of learning objectives
46:00 Additional resources and Postman product roadmap
48:25 Q&A

Speakers:
Meenakshi Dhanani, Developer Advocate
Arlemi Turpault, Senior Developer Advocate