Join us for an hour-long introductory-level API design basics learning session where we talk about what makes a good API. This session is oriented towards designers and developers and takes a look into industry best practices and standards, how to design APIs in Postman, and how we can prepare our workspace for the Postman Public API Network. In this Postman learning session, we specifically dive into the design experiences for OpenAPI.

1. Attendees are muted
Ask questions under Q&A
A recording of this session will be shared
Post-event feedback survey will be given at the end
1
2
3
4
General Information
@getpostman @poojamakes @apihandyman

2. All rights reserved by Postman Inc
Designing Good
API Experiences

3. @poojamakes
@apihandyman
@getpostman @poojamakes @apihandyman

4. ● Poll question 1
How much experience do you have with API Design ?
● Poll question 2
How much experience do you have with REST API ?
● Poll question 3
How long have you been using Postman ?
A little about you
@getpostman @poojamakes @apihandyman

5. How to Design APIs
Importance of the Good API Experience
Better Practices - Demo for REST API
Resources & Q&A
1
2
3
4
Agenda
@getpostman @poojamakes @apihandyman

6. At the end of this session, you will:
● Determine business needs for designing APIs and the problems they are
trying to solve.
● Analyze and understand design principles and better practices for REST
APIs & OpenAPI.
● Learn the process of setting up workspace, create documentation, and
publish APIs to the Public API Network
Learning Objectives
@getpostman @poojamakes @apihandyman

7. 8 traits of an effective API-first design
What problem is your API trying to solve?
@getpostman @poojamakes @apihandyman

8. The Impact of the API Experience
Good API experience
● Usability & Reusability
● Time to value
● Create APIs will evolve smoothly
● Less risk of introducing breaking change
Bad API experience
● Costly
● Decreased Productivity both Consumer &
Producer
● Takes longer time for integration
● Leads to shift delivery dates
@getpostman @poojamakes @apihandyman

9. Better Practices and Usual Concerns for Good API Design
● Naming
● Data Modeling
● Required/ Not Required
● Error handling
● Documentation
● Consistency
@getpostman @poojamakes @apihandyman

10. Postman Learning
learning.postman.com/
30 Days of Postman for Developers
postman.com/postman/workspace/30-days-of-postman-for-developers/
Postman Intergalactic
postman.com/events/intergalactic/
Community Forum
community.postman.com
Additional Resources
@getpostman @poojamakes @apihandyman

11. What we learned today:
● 8 traits of an effective API-first design
● Impact of both good and bad API Experience
● Better Practices and Usual Concerns for API Design
● Design principles and better practices for OpenAPI.
Learning Objectives
@getpostman @poojamakes @apihandyman

12. Please tell us about
your experience!
https://tinyurl.com/goodapiexperience
FEEDBACK SURVEY
@getpostman @poojamakes @apihandyman

13. Q&A
@getpostman @poojamakes @apihandyman

14. Thank You
@getpostman @poojamakes @apihandyman