Designing Good API Experiences Session 24

Postman
PostmanPostman
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
All rights reserved by Postman Inc
Designing Good
API Experiences
@poojamakes
@apihandyman
@getpostman @poojamakes @apihandyman
● 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
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
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
8 traits of an effective API-first design
What problem is your API trying to solve?
@getpostman @poojamakes @apihandyman
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
Better Practices and Usual Concerns for Good API Design
● Naming
● Data Modeling
● Required/ Not Required
● Error handling
● Documentation
● Consistency
@getpostman @poojamakes @apihandyman
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
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
Please tell us about
your experience!
https://tinyurl.com/goodapiexperience
FEEDBACK SURVEY
@getpostman @poojamakes @apihandyman
Q&A
@getpostman @poojamakes @apihandyman
Thank You
@getpostman @poojamakes @apihandyman
1 de 14

Más contenido relacionado

La actualidad más candente

Postman Webinar: Postman 101Postman Webinar: Postman 101
Postman Webinar: Postman 101Nikita Sharma
411 vistas16 diapositivas

La actualidad más candente(20)

Similar a Designing Good API Experiences Session 24(20)

Último(20)

AMD: 4th Generation EPYC CXL DemoAMD: 4th Generation EPYC CXL Demo
AMD: 4th Generation EPYC CXL Demo
CXL Forum113 vistas
CXL at OCPCXL at OCP
CXL at OCP
CXL Forum158 vistas
ISWC2023-McGuinnessTWC16x9FinalShort.pdfISWC2023-McGuinnessTWC16x9FinalShort.pdf
ISWC2023-McGuinnessTWC16x9FinalShort.pdf
Deborah McGuinness80 vistas
Architecting multi-cloud ready applicationsArchitecting multi-cloud ready applications
Architecting multi-cloud ready applications
Swaminathan Vetri43 vistas
Java Platform Approach 1.0 - Picnic MeetupJava Platform Approach 1.0 - Picnic Meetup
Java Platform Approach 1.0 - Picnic Meetup
Rick Ossendrijver20 vistas
Green Leaf Consulting: Capabilities DeckGreen Leaf Consulting: Capabilities Deck
Green Leaf Consulting: Capabilities Deck
GreenLeafConsulting147 vistas

Designing Good API Experiences Session 24

  • 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
  • 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