Getting Started with OpenAPI in Postman | Postman Intergalactic

Fork the collection:

Watch the API schema reference to be notified of updates:

0:00 - Introduction to Joyce and Arnaud
0:55 - Agenda and learning objectives
03:13 - Live poll about specification usage
03:34 - What is API-First
04:30 - View the learning materials
05:50 - What is the OpenAPI Specification (OAS)
08:10 - Consider the needs of all your stakeholders
09:15 - Distill stakeholder goals into API operations and resources
11:18 - Create a new OpenAPI from scratch in Postman
15:55 - Live poll about how to represent a list of resources
24:37 - Live poll about HTTP status to return when no postmanaut is found
25:55 - Handling error responses
28:15 - Using reusable components for error schema
36:58 - Connect repository for version control
38:15 - Generate a test collection from the OAS
40:14 - Generate server-side code to run boilerplate application locally
46:50 - Insert a test snippet
47:22 - Schema validation for 1) API format, and 2) between collection and API
51:30 - Overview of upcoming session topics
52:30 - Recap of Learning Objectives
55:00 - What's Next in Postman
56:05 - Additional Learning Resources for testing
58:16 - Upcoming Intergalactic events

Join us for a one-hour, introductory Postman learning session geared specifically for developers, API architects, and anyone involved in producing APIs. We'll walk through an overview of the OpenAPI specification as well as tips and best practices around using an API-first approach.

Here’s what we’ll do in this session:
✅ Explore the applications of the OpenAPI Specification
✅Design an API effectively using an API-first approach
✅Leverage reusable components to ensure consistency across your definition
✅Customize generated collections based on the API definition
✅Experience the complete API producer lifecycle starting with OpenAPI

Prerequisites:
- Create a Postman account, and then sign in.
- Download and install the Postman desktop agent, which will enable you to use the web version of Postman that we use in Intergalactic sessions.

[AlexSirota]

What a terrific introduction to postman and openapi. For me it was a tour de force of Postman’s capabilities. Thank you.

[HunterYavitz]

What a hidden gem! Working on a kotlin backend and vue.js front end all with an openapi spec. This was just what I was looking for. Thanks!

[mostafaelmenbawy]

Super eye opening session. I learned a loooot !

[michancio]

Awesome introduction to the Postman, best ever tool ;)

[ArielMoments]

This is what I was actually looking for.

[dilankarathnasiri]

Thank you very much for this valuable video

[dpanassol]

Nice but i really would like to see how to create mock server from this API spec. Its one of the essential things in Contract-first development.

[iustus_]

It's always hard to follow along as finding the Postman Workspaces is very confusing and messy. Is that a fair statement that others experience?

[pleabargain]

23:26 totally jumped to new content with no explanation of where it came from. :(

[daredevone]

This video doesn't really help much when you use Desktop software because the UIs are so different from this web-based one. I use 10.2.0 now but the prev version of 10.1.x was the same. 😟

[ArielMoments]

To Summarize:

1. Needs First
2. OPEN API Second but API First always.

Otherwise, you'll be making APIs that nobody wants.

[pleabargain]

27:30 Jerks over to another page without explanation again to grab data. :( Make it clear! Give us the URL or at least why this new content is necessary.