SlideShare uma empresa Scribd logo
1 de 42
Baixar para ler offline
All rights reserved by Postman Inc
Welcome to Space
Camp!
Sean Keegan
Developer Advocate
Agenda
Breaks will be taken throughout the day
The workshop sessions may have
interactive quizzes throughout. You can
use a mobile device or desktop browser to
participate. We’ll show the URL on the big
screen and drop the link in Discord as well.
Your feedback is welcomed and
appreciated, and we’ll be using your
feedback submissions to draw for prizes
at the end of the day. Watch for feedback
URLs on the screen and in Discord.!
9:30am Foundations: Introduction to API-First
10:15am CJ Avilla, Stripe: How Stripe API Features Land
10:45am Workshop: Using OpenAPI with API-First
12:15pm Lunch
1:30pm Workshop: API Workflows, Part 1
2:45pm Daniele Bernardi, Twitter: How Twitter Builds in the Open
3:15pm Workshop: API Workflows, part 2
4:30pm Final Thoughts, Social Activity to Follow
Please ask questions
throughout the day
WE’RE HERE TO HELP
https://go.pstmn.io/spacecamp-discord
https://go.pstmn.io/spacecamp-notes
All rights reserved by Postman Inc
Welcome to
API-First!
W. Ian Douglas
Sr Developer Advocate
Introducing API-First
and, Why do API-First
LEVEL-SETTING
Please ask questions
throughout the day
WE’RE HERE TO HELP
https://go.pstmn.io/spacecamp-discord
https://go.pstmn.io/spacecamp-notes
What is
“API-First”?
Introducing …
● Early Feedback System
By spending time on the API design early, you can get
feedback from stakeholders before you ever write code.
● Clearer Design and Planning
With the end-users in mind, you have a clearer plan of what
you want to build, and iterate from there.
● Decouple Legacy Constraints
Especially for companies who already have APIs or systems
in place, starting something new can free you from “the way
we’ve always done it”.
It’s a “Mindset” Define
Design
Document
Deploy
Test
Secure
Monitor
Discover
● Early Feedback System
By spending time on the API design early, you can get
feedback from stakeholders before you ever write code.
● Clearer Design and Planning
With the end-users in mind, you have a clearer plan of what
you want to build, and iterate from there.
● Decouple Legacy Constraints
Especially for companies who already have APIs or systems
in place, starting something new can free you from “the way
we’ve always done it”.
It’s a “Mindset” Define
Design
Document
Test
● Early Feedback System
By spending time on the API design early, you can get
feedback from stakeholders before you ever write code.
● Clearer Design and Planning
With the end-users in mind, you have a clearer plan of what
you want to build, and iterate from there.
● Decouple Legacy Constraints
Especially for companies who already have APIs or systems
in place, starting something new can free you from “the way
we’ve always done it”.
It’s a “Mindset”
Image credit: tenor.com “free your mind”
…-Driven Development
You may know of
…-Driven Development
Only implement what you
MUST, then you have the
flexibility for HOW
You may know of
Pop Quiz!
API-First Mindset
Long-term Practice
API-First Mindset
● You need a Plan to follow
Your team, and preferably your company or organization,
needs a plan. This should be built, ideally, with various
people on the team. This plan is “governance”.
● Build “Contracts” and “Validators”
Every endpoint in your API should be well documented for
expectations of inputs and outputs, including data types.
This should include what kinds of errors to expect and how
you’ll handle those errors.
● What is your “Source of Truth”?
However you design your API, you need a “source of truth”
that is easy to find, searchable, well-documented, and
shared. It needs to be easy to find, and easy to
communicate.
Long-Term Planning for API-First
How do We
Become API-First if
We Already have
APIs?
BUT …
Let’s Review
WHEW…
● API-First Mindset
Designing the API interfaces, contracts, and governance
before any implementation.
● Governance
Standardization, Principles, by which your organization will
plan and execute their APIs.
● API Design Lifecycle
Definition, Design, Documentation, Testing, Implementation,
Testing, Security, Monitoring, etc.
Definitions
● Source of Truth
Documentation for the definition of your API, from which all
other work is derived and developed.
● Contracts and Validators
Documenting your API endpoints (aka “interfaces”), and
their responses, both as data and as error responses.
Ideally these responses use reusable “components”
● OpenAPI
… introducing, Arnaud, the API Handyman!
These definitions are provided in your follow-along notes, and linked in Discord.
All rights reserved by Postman Inc
How OpenAPI
fuels API-first
Arnaud Lauret
OpenAPI Tech Lead
What is the OpenAPI
Specification?
HOW OPENAPI FUELS API-FIRST
A machine-readable and human-friendly API description format
● Describes REST(ish) web APIs
● Uses JSON Schema to describe data
● Written in JSON or YAML
● Vendor neutral, technology agnostic
and Interoperable standard
A bit of history
● 2011 - Swagger tools for SDKs and
documentation
● 2014 - Swagger 2.0 tools and
specification
● 2015 - Swagger 2.0 specification
donated to the OpenAPI Initiative
● 2017 - OpenAPI 3.0 released
Don’t use Swagger 2.0 specification anymore
Naming is hard
● OpenAPI is not only for “Open APIs”
● Private/partner/public
How OpenAPI can
be used?
HOW OPENAPI FUELS API-FIRST
Anyway, like I was sayin', OpenAPI is an essential
ingredient of the API world. You can barbecue it, boil it,
broil it, bake it, saute it. There's uh, OpenAPI-kabobs,
OpenAPI creole, OpenAPI gumbo. Pan fried, deep fried,
stir-fried. There's pineapple OpenAPI, lemon OpenAPI,
coconut OpenAPI, pepper OpenAPI, OpenAPI soup,
OpenAPI stew, OpenAPI salad, OpenAPI and potatoes,
OpenAPI burger, OpenAPI sandwich. That- that's about
it.
API-Bubba Blue
“
A glimpse on OpenAPI endless possibilities
● Documentation
● Design
● Governance
● Mock
● Code generation
● Test
● Configuration
● Reverse engineering
OpenAPI + API-First
HOW OPENAPI FUELS API-FIRST
● API-First Mindset
Designing the API interfaces, contracts, and governance
before any implementation.
● Governance
Standardization, Principles, by which your organization will
plan and execute their APIs.
● API Design Lifecycle
Definition, Design, Documentation, Testing, Implementation,
Testing, Security, Monitoring, etc.
OpenAPIfied Definitions
● Source of Truth
Documentation for the definition of your API, from which all
other work is derived and developed.
● Contracts and Validators
Documenting your API endpoints (aka “interfaces”), and
their responses, both as data and as error responses.
Ideally these responses use reusable “components”
OpenAPI is useful along the whole API lifecycle
Define
Design
Document
Deploy
Test
Secure
Monitor
Discover
OpenAPI is a Rosetta Stone of the API-first world
● A black basalt stone that bridged the
gap between Greek and Egyptian
hieroglyphics
● One that gives a clue to understanding
Photo by Hans Hillewaert
OpenAPI is a Rosetta Stone of the API-first world
● A bridge between people, between API
tools
● Gives an understanding of API yet to
come, APIs you created, APIs other
created
Photo by Hans Hillewaert
Let’s Recap
Feedback
Developer Advocacy, Stripe
@cjav_dev
34
API feature lifecycle
CJ Avilla
Welcome!
All rights reserved by Postman Inc
Session 2:
Applying OpenAPI
and API-First
Arnaud Lauret
OpenAPI Tech Lead
Ian Douglas
Sr Developer Advocate
Please ask questions
throughout the day
WE’RE HERE TO HELP
https://go.pstmn.io/spacecamp-discord
https://go.pstmn.io/spacecamp-notes
Let’s Recap
Feedback
https://go.pstmn.io/sc-feedback-am
All rights reserved by Postman Inc
Session 3 and 4:
Advanced API
Workflows
Arlemi Turpault
Sr Developer Advocate
Ian Douglas
Sr Developer Advocate
Please ask questions
throughout the day
WE’RE HERE TO HELP
https://go.pstmn.io/spacecamp-discord
https://go.pstmn.io/spacecamp-notes
HEAD OF DEVELOPER ADVOCACY AND
COMMUNITY, TWITTER
Daniele
Bernardi
CHIEF EVANGELIST, POSTMAN
Kin
Lane
@kinlane
Fireside Chat:
How Twitter Builds
in the Open
@i_am_daniele
Let’s Recap
Feedback
https://go.pstmn.io/sc-feedback-pm
All rights reserved by Postman Inc
Closing Thoughts
Joyce Lin
Director of Developer Relations

Mais conteúdo relacionado

Mais procurados

Mais procurados (20)

Advanced API Debugging
Advanced API DebuggingAdvanced API Debugging
Advanced API Debugging
 
Reasons To Automate API Testing Process
Reasons To Automate API Testing ProcessReasons To Automate API Testing Process
Reasons To Automate API Testing Process
 
Postman 101 for Students
Postman 101 for StudentsPostman 101 for Students
Postman 101 for Students
 
B4USolution_API-Testing
B4USolution_API-TestingB4USolution_API-Testing
B4USolution_API-Testing
 
Postman: An Introduction for Testers
Postman: An Introduction for TestersPostman: An Introduction for Testers
Postman: An Introduction for Testers
 
Postman: An Introduction for Testers
Postman: An Introduction for TestersPostman: An Introduction for Testers
Postman: An Introduction for Testers
 
API Testing. Streamline your testing process.
API Testing. Streamline your testing process.API Testing. Streamline your testing process.
API Testing. Streamline your testing process.
 
Api Testing
Api TestingApi Testing
Api Testing
 
API Testing
API TestingAPI Testing
API Testing
 
API TESTING
API TESTINGAPI TESTING
API TESTING
 
API Testing: The heart of functional testing" with Bj Rollison
API Testing: The heart of functional testing" with Bj RollisonAPI Testing: The heart of functional testing" with Bj Rollison
API Testing: The heart of functional testing" with Bj Rollison
 
Space Camp :: API Lifecycle, Part I: Build and Test an API
Space Camp :: API Lifecycle, Part I: Build and Test an APISpace Camp :: API Lifecycle, Part I: Build and Test an API
Space Camp :: API Lifecycle, Part I: Build and Test an API
 
An Introduction To Automated API Testing
An Introduction To Automated API TestingAn Introduction To Automated API Testing
An Introduction To Automated API Testing
 
Postman 101 & Office Hours
Postman 101 & Office HoursPostman 101 & Office Hours
Postman 101 & Office Hours
 
POST/CON 2019 Workshop: Testing, Automated Testing, and Reporting APIs with P...
POST/CON 2019 Workshop: Testing, Automated Testing, and Reporting APIs with P...POST/CON 2019 Workshop: Testing, Automated Testing, and Reporting APIs with P...
POST/CON 2019 Workshop: Testing, Automated Testing, and Reporting APIs with P...
 
Testing Your APIs: Postman, Newman, and Beyond
Testing Your APIs: Postman, Newman, and BeyondTesting Your APIs: Postman, Newman, and Beyond
Testing Your APIs: Postman, Newman, and Beyond
 
An introduction to api testing | David Tzemach
An introduction to api testing | David TzemachAn introduction to api testing | David Tzemach
An introduction to api testing | David Tzemach
 
API Lifecycle, Part 2: Monitor and Deploy an API
API Lifecycle, Part 2: Monitor and Deploy an APIAPI Lifecycle, Part 2: Monitor and Deploy an API
API Lifecycle, Part 2: Monitor and Deploy an API
 
[GDSC-ADYPU] APIs 101 with Postman
[GDSC-ADYPU] APIs 101 with Postman[GDSC-ADYPU] APIs 101 with Postman
[GDSC-ADYPU] APIs 101 with Postman
 
Postman Webinar: Postman 101
Postman Webinar: Postman 101Postman Webinar: Postman 101
Postman Webinar: Postman 101
 

Semelhante a Space Camp June 2022 - API First.pdf

Semelhante a Space Camp June 2022 - API First.pdf (20)

INTERFACE, by apidays - How to Win Friends and Influence People with API First
INTERFACE, by apidays - How to Win Friends and Influence People with API FirstINTERFACE, by apidays - How to Win Friends and Influence People with API First
INTERFACE, by apidays - How to Win Friends and Influence People with API First
 
The Complete Guide to API Development in 2022.pdf
The Complete Guide to API Development in 2022.pdfThe Complete Guide to API Development in 2022.pdf
The Complete Guide to API Development in 2022.pdf
 
apidays LIVE Helsinki & North 2022_How to Win Friends and Influence People wi...
apidays LIVE Helsinki & North 2022_How to Win Friends and Influence People wi...apidays LIVE Helsinki & North 2022_How to Win Friends and Influence People wi...
apidays LIVE Helsinki & North 2022_How to Win Friends and Influence People wi...
 
Spec-first API Design for Speed and Safety
Spec-first API Design for Speed and SafetySpec-first API Design for Speed and Safety
Spec-first API Design for Speed and Safety
 
Why your APIs should fly first class
Why your APIs should fly first classWhy your APIs should fly first class
Why your APIs should fly first class
 
OpenAPI Intro (1).pdf
OpenAPI Intro (1).pdfOpenAPI Intro (1).pdf
OpenAPI Intro (1).pdf
 
API-First Design and Django
API-First Design and DjangoAPI-First Design and Django
API-First Design and Django
 
The Art of API Design, by David Biesack at Apiture
The Art of API Design, by David Biesack at ApitureThe Art of API Design, by David Biesack at Apiture
The Art of API Design, by David Biesack at Apiture
 
INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...
INTERFACE, by apidays  - The 8 Key Components of a Modern API Stack by Iddo G...INTERFACE, by apidays  - The 8 Key Components of a Modern API Stack by Iddo G...
INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...
 
INTERFACE by apidays 2023 - Battle-tested APIs, Jean Burellier, Sanofi
INTERFACE by apidays 2023 - Battle-tested APIs, Jean Burellier, SanofiINTERFACE by apidays 2023 - Battle-tested APIs, Jean Burellier, Sanofi
INTERFACE by apidays 2023 - Battle-tested APIs, Jean Burellier, Sanofi
 
Adopting a Design-First Approach to API Development with SwaggerHub
Adopting a Design-First Approach to API Development with SwaggerHubAdopting a Design-First Approach to API Development with SwaggerHub
Adopting a Design-First Approach to API Development with SwaggerHub
 
General Terminologies to understand programming and Data Science
General Terminologies to understand programming and Data ScienceGeneral Terminologies to understand programming and Data Science
General Terminologies to understand programming and Data Science
 
Web API Design
Web API DesignWeb API Design
Web API Design
 
Web API Design: Crafting Interfaces that Developers Love
Web API Design:  Crafting Interfaces that Developers LoveWeb API Design:  Crafting Interfaces that Developers Love
Web API Design: Crafting Interfaces that Developers Love
 
Crafting a Cloud Native API Platform to Accelerate Your Platform Maturity - B...
Crafting a Cloud Native API Platform to Accelerate Your Platform Maturity - B...Crafting a Cloud Native API Platform to Accelerate Your Platform Maturity - B...
Crafting a Cloud Native API Platform to Accelerate Your Platform Maturity - B...
 
Speaking APIsh makes your business more agile
Speaking APIsh makes your business more agileSpeaking APIsh makes your business more agile
Speaking APIsh makes your business more agile
 
Rebooting APIs at scale
Rebooting APIs at scaleRebooting APIs at scale
Rebooting APIs at scale
 
APIDays - API Design Workshop
APIDays - API Design WorkshopAPIDays - API Design Workshop
APIDays - API Design Workshop
 
API presentation
API presentationAPI presentation
API presentation
 
Clickslide Datadipity Beta V1
Clickslide Datadipity Beta V1Clickslide Datadipity Beta V1
Clickslide Datadipity Beta V1
 

Mais de Postman

Discovering Public APIs and Public API Network with Postman
Discovering Public APIs and Public API Network with PostmanDiscovering Public APIs and Public API Network with Postman
Discovering Public APIs and Public API Network with Postman
Postman
 
Optimizing Teamwork: Harnessing Collections & Workspaces for Collaboration
Optimizing Teamwork: Harnessing Collections & Workspaces for CollaborationOptimizing Teamwork: Harnessing Collections & Workspaces for Collaboration
Optimizing Teamwork: Harnessing Collections & Workspaces for Collaboration
Postman
 

Mais de Postman (20)

Elevating Developer Experiences with AI-Powered API Testing & Documentation
Elevating Developer Experiences with AI-Powered API Testing & DocumentationElevating Developer Experiences with AI-Powered API Testing & Documentation
Elevating Developer Experiences with AI-Powered API Testing & Documentation
 
Discovering Public APIs and Public API Network with Postman
Discovering Public APIs and Public API Network with PostmanDiscovering Public APIs and Public API Network with Postman
Discovering Public APIs and Public API Network with Postman
 
Optimizing Teamwork: Harnessing Collections & Workspaces for Collaboration
Optimizing Teamwork: Harnessing Collections & Workspaces for CollaborationOptimizing Teamwork: Harnessing Collections & Workspaces for Collaboration
Optimizing Teamwork: Harnessing Collections & Workspaces for Collaboration
 
API testing Beyond the Basics AI & Automation Techniques
API testing Beyond the Basics AI & Automation TechniquesAPI testing Beyond the Basics AI & Automation Techniques
API testing Beyond the Basics AI & Automation Techniques
 
Not Your Grandma’s Rate Limiting (slides)
Not Your Grandma’s Rate Limiting (slides)Not Your Grandma’s Rate Limiting (slides)
Not Your Grandma’s Rate Limiting (slides)
 
Five Ways to Automate API Testing with Postman
Five Ways to Automate API Testing with PostmanFive Ways to Automate API Testing with Postman
Five Ways to Automate API Testing with Postman
 
How to Scale APIs-as-Product for Future Success
How to Scale APIs-as-Product for Future SuccessHow to Scale APIs-as-Product for Future Success
How to Scale APIs-as-Product for Future Success
 
Revolutionizing API Development: Collaborative Workflows with Postman
Revolutionizing API Development: Collaborative Workflows with PostmanRevolutionizing API Development: Collaborative Workflows with Postman
Revolutionizing API Development: Collaborative Workflows with Postman
 
Everything You Always Wanted to Know About AsyncAPI
Everything You Always Wanted to Know About AsyncAPIEverything You Always Wanted to Know About AsyncAPI
Everything You Always Wanted to Know About AsyncAPI
 
Elevating Event-Driven World: A Deep Dive into AsyncAPI v3
Elevating Event-Driven World: A Deep Dive into AsyncAPI v3Elevating Event-Driven World: A Deep Dive into AsyncAPI v3
Elevating Event-Driven World: A Deep Dive into AsyncAPI v3
 
Five Things You SHOULD Know About Postman
Five Things You SHOULD Know About PostmanFive Things You SHOULD Know About Postman
Five Things You SHOULD Know About Postman
 
Integration-, Snapshot- and Performance-Testing APIs
Integration-, Snapshot- and Performance-Testing APIs Integration-, Snapshot- and Performance-Testing APIs
Integration-, Snapshot- and Performance-Testing APIs
 
How ChatGPT led OpenAPI's Recent Spike in Popularity
How ChatGPT led OpenAPI's Recent Spike in PopularityHow ChatGPT led OpenAPI's Recent Spike in Popularity
How ChatGPT led OpenAPI's Recent Spike in Popularity
 
Exploring Postman’s VS Code Extension
Exploring Postman’s VS Code ExtensionExploring Postman’s VS Code Extension
Exploring Postman’s VS Code Extension
 
2023 State of the API Report: Key Findings and Trends
2023 State of the API Report: Key Findings and Trends2023 State of the API Report: Key Findings and Trends
2023 State of the API Report: Key Findings and Trends
 
Nordic- APIOps is here What will you build in an API First World
Nordic- APIOps is here What will you build in an API First World Nordic- APIOps is here What will you build in an API First World
Nordic- APIOps is here What will you build in an API First World
 
Testing and Developing gRPC APIs
Testing and Developing gRPC APIsTesting and Developing gRPC APIs
Testing and Developing gRPC APIs
 
Testing and Developing GraphQL APIs
Testing and Developing GraphQL APIsTesting and Developing GraphQL APIs
Testing and Developing GraphQL APIs
 
Introduction to API Security - Intergalactic
Introduction to API Security - IntergalacticIntroduction to API Security - Intergalactic
Introduction to API Security - Intergalactic
 
Unboxing What's New in Postman Q2
Unboxing What's New in Postman Q2Unboxing What's New in Postman Q2
Unboxing What's New in Postman Q2
 

Último

1029-Danh muc Sach Giao Khoa khoi 6.pdf
1029-Danh muc Sach Giao Khoa khoi  6.pdf1029-Danh muc Sach Giao Khoa khoi  6.pdf
1029-Danh muc Sach Giao Khoa khoi 6.pdf
QucHHunhnh
 
Beyond the EU: DORA and NIS 2 Directive's Global Impact
Beyond the EU: DORA and NIS 2 Directive's Global ImpactBeyond the EU: DORA and NIS 2 Directive's Global Impact
Beyond the EU: DORA and NIS 2 Directive's Global Impact
PECB
 
Activity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdfActivity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdf
ciinovamais
 

Último (20)

Micro-Scholarship, What it is, How can it help me.pdf
Micro-Scholarship, What it is, How can it help me.pdfMicro-Scholarship, What it is, How can it help me.pdf
Micro-Scholarship, What it is, How can it help me.pdf
 
Holdier Curriculum Vitae (April 2024).pdf
Holdier Curriculum Vitae (April 2024).pdfHoldier Curriculum Vitae (April 2024).pdf
Holdier Curriculum Vitae (April 2024).pdf
 
This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.
 
Unit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptxUnit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptx
 
Python Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docxPython Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docx
 
1029-Danh muc Sach Giao Khoa khoi 6.pdf
1029-Danh muc Sach Giao Khoa khoi  6.pdf1029-Danh muc Sach Giao Khoa khoi  6.pdf
1029-Danh muc Sach Giao Khoa khoi 6.pdf
 
ICT role in 21st century education and it's challenges.
ICT role in 21st century education and it's challenges.ICT role in 21st century education and it's challenges.
ICT role in 21st century education and it's challenges.
 
Key note speaker Neum_Admir Softic_ENG.pdf
Key note speaker Neum_Admir Softic_ENG.pdfKey note speaker Neum_Admir Softic_ENG.pdf
Key note speaker Neum_Admir Softic_ENG.pdf
 
Grant Readiness 101 TechSoup and Remy Consulting
Grant Readiness 101 TechSoup and Remy ConsultingGrant Readiness 101 TechSoup and Remy Consulting
Grant Readiness 101 TechSoup and Remy Consulting
 
Z Score,T Score, Percential Rank and Box Plot Graph
Z Score,T Score, Percential Rank and Box Plot GraphZ Score,T Score, Percential Rank and Box Plot Graph
Z Score,T Score, Percential Rank and Box Plot Graph
 
ICT Role in 21st Century Education & its Challenges.pptx
ICT Role in 21st Century Education & its Challenges.pptxICT Role in 21st Century Education & its Challenges.pptx
ICT Role in 21st Century Education & its Challenges.pptx
 
Measures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and ModeMeasures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and Mode
 
Beyond the EU: DORA and NIS 2 Directive's Global Impact
Beyond the EU: DORA and NIS 2 Directive's Global ImpactBeyond the EU: DORA and NIS 2 Directive's Global Impact
Beyond the EU: DORA and NIS 2 Directive's Global Impact
 
Unit-IV- Pharma. Marketing Channels.pptx
Unit-IV- Pharma. Marketing Channels.pptxUnit-IV- Pharma. Marketing Channels.pptx
Unit-IV- Pharma. Marketing Channels.pptx
 
INDIA QUIZ 2024 RLAC DELHI UNIVERSITY.pptx
INDIA QUIZ 2024 RLAC DELHI UNIVERSITY.pptxINDIA QUIZ 2024 RLAC DELHI UNIVERSITY.pptx
INDIA QUIZ 2024 RLAC DELHI UNIVERSITY.pptx
 
General Principles of Intellectual Property: Concepts of Intellectual Proper...
General Principles of Intellectual Property: Concepts of Intellectual  Proper...General Principles of Intellectual Property: Concepts of Intellectual  Proper...
General Principles of Intellectual Property: Concepts of Intellectual Proper...
 
Sociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning ExhibitSociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning Exhibit
 
Advanced Views - Calendar View in Odoo 17
Advanced Views - Calendar View in Odoo 17Advanced Views - Calendar View in Odoo 17
Advanced Views - Calendar View in Odoo 17
 
Activity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdfActivity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdf
 
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
 

Space Camp June 2022 - API First.pdf

  • 1. All rights reserved by Postman Inc Welcome to Space Camp! Sean Keegan Developer Advocate
  • 2. Agenda Breaks will be taken throughout the day The workshop sessions may have interactive quizzes throughout. You can use a mobile device or desktop browser to participate. We’ll show the URL on the big screen and drop the link in Discord as well. Your feedback is welcomed and appreciated, and we’ll be using your feedback submissions to draw for prizes at the end of the day. Watch for feedback URLs on the screen and in Discord.! 9:30am Foundations: Introduction to API-First 10:15am CJ Avilla, Stripe: How Stripe API Features Land 10:45am Workshop: Using OpenAPI with API-First 12:15pm Lunch 1:30pm Workshop: API Workflows, Part 1 2:45pm Daniele Bernardi, Twitter: How Twitter Builds in the Open 3:15pm Workshop: API Workflows, part 2 4:30pm Final Thoughts, Social Activity to Follow
  • 3. Please ask questions throughout the day WE’RE HERE TO HELP https://go.pstmn.io/spacecamp-discord https://go.pstmn.io/spacecamp-notes
  • 4. All rights reserved by Postman Inc Welcome to API-First! W. Ian Douglas Sr Developer Advocate
  • 5. Introducing API-First and, Why do API-First LEVEL-SETTING
  • 6. Please ask questions throughout the day WE’RE HERE TO HELP https://go.pstmn.io/spacecamp-discord https://go.pstmn.io/spacecamp-notes
  • 8. ● Early Feedback System By spending time on the API design early, you can get feedback from stakeholders before you ever write code. ● Clearer Design and Planning With the end-users in mind, you have a clearer plan of what you want to build, and iterate from there. ● Decouple Legacy Constraints Especially for companies who already have APIs or systems in place, starting something new can free you from “the way we’ve always done it”. It’s a “Mindset” Define Design Document Deploy Test Secure Monitor Discover
  • 9. ● Early Feedback System By spending time on the API design early, you can get feedback from stakeholders before you ever write code. ● Clearer Design and Planning With the end-users in mind, you have a clearer plan of what you want to build, and iterate from there. ● Decouple Legacy Constraints Especially for companies who already have APIs or systems in place, starting something new can free you from “the way we’ve always done it”. It’s a “Mindset” Define Design Document Test
  • 10. ● Early Feedback System By spending time on the API design early, you can get feedback from stakeholders before you ever write code. ● Clearer Design and Planning With the end-users in mind, you have a clearer plan of what you want to build, and iterate from there. ● Decouple Legacy Constraints Especially for companies who already have APIs or systems in place, starting something new can free you from “the way we’ve always done it”. It’s a “Mindset” Image credit: tenor.com “free your mind”
  • 12. …-Driven Development Only implement what you MUST, then you have the flexibility for HOW You may know of
  • 15. ● You need a Plan to follow Your team, and preferably your company or organization, needs a plan. This should be built, ideally, with various people on the team. This plan is “governance”. ● Build “Contracts” and “Validators” Every endpoint in your API should be well documented for expectations of inputs and outputs, including data types. This should include what kinds of errors to expect and how you’ll handle those errors. ● What is your “Source of Truth”? However you design your API, you need a “source of truth” that is easy to find, searchable, well-documented, and shared. It needs to be easy to find, and easy to communicate. Long-Term Planning for API-First
  • 16. How do We Become API-First if We Already have APIs? BUT …
  • 18. ● API-First Mindset Designing the API interfaces, contracts, and governance before any implementation. ● Governance Standardization, Principles, by which your organization will plan and execute their APIs. ● API Design Lifecycle Definition, Design, Documentation, Testing, Implementation, Testing, Security, Monitoring, etc. Definitions ● Source of Truth Documentation for the definition of your API, from which all other work is derived and developed. ● Contracts and Validators Documenting your API endpoints (aka “interfaces”), and their responses, both as data and as error responses. Ideally these responses use reusable “components” ● OpenAPI … introducing, Arnaud, the API Handyman! These definitions are provided in your follow-along notes, and linked in Discord.
  • 19. All rights reserved by Postman Inc How OpenAPI fuels API-first Arnaud Lauret OpenAPI Tech Lead
  • 20. What is the OpenAPI Specification? HOW OPENAPI FUELS API-FIRST
  • 21. A machine-readable and human-friendly API description format ● Describes REST(ish) web APIs ● Uses JSON Schema to describe data ● Written in JSON or YAML ● Vendor neutral, technology agnostic and Interoperable standard
  • 22. A bit of history ● 2011 - Swagger tools for SDKs and documentation ● 2014 - Swagger 2.0 tools and specification ● 2015 - Swagger 2.0 specification donated to the OpenAPI Initiative ● 2017 - OpenAPI 3.0 released
  • 23. Don’t use Swagger 2.0 specification anymore
  • 24. Naming is hard ● OpenAPI is not only for “Open APIs” ● Private/partner/public
  • 25. How OpenAPI can be used? HOW OPENAPI FUELS API-FIRST
  • 26. Anyway, like I was sayin', OpenAPI is an essential ingredient of the API world. You can barbecue it, boil it, broil it, bake it, saute it. There's uh, OpenAPI-kabobs, OpenAPI creole, OpenAPI gumbo. Pan fried, deep fried, stir-fried. There's pineapple OpenAPI, lemon OpenAPI, coconut OpenAPI, pepper OpenAPI, OpenAPI soup, OpenAPI stew, OpenAPI salad, OpenAPI and potatoes, OpenAPI burger, OpenAPI sandwich. That- that's about it. API-Bubba Blue “
  • 27. A glimpse on OpenAPI endless possibilities ● Documentation ● Design ● Governance ● Mock ● Code generation ● Test ● Configuration ● Reverse engineering
  • 28. OpenAPI + API-First HOW OPENAPI FUELS API-FIRST
  • 29. ● API-First Mindset Designing the API interfaces, contracts, and governance before any implementation. ● Governance Standardization, Principles, by which your organization will plan and execute their APIs. ● API Design Lifecycle Definition, Design, Documentation, Testing, Implementation, Testing, Security, Monitoring, etc. OpenAPIfied Definitions ● Source of Truth Documentation for the definition of your API, from which all other work is derived and developed. ● Contracts and Validators Documenting your API endpoints (aka “interfaces”), and their responses, both as data and as error responses. Ideally these responses use reusable “components”
  • 30. OpenAPI is useful along the whole API lifecycle Define Design Document Deploy Test Secure Monitor Discover
  • 31. OpenAPI is a Rosetta Stone of the API-first world ● A black basalt stone that bridged the gap between Greek and Egyptian hieroglyphics ● One that gives a clue to understanding Photo by Hans Hillewaert
  • 32. OpenAPI is a Rosetta Stone of the API-first world ● A bridge between people, between API tools ● Gives an understanding of API yet to come, APIs you created, APIs other created Photo by Hans Hillewaert
  • 34. Developer Advocacy, Stripe @cjav_dev 34 API feature lifecycle CJ Avilla Welcome!
  • 35. All rights reserved by Postman Inc Session 2: Applying OpenAPI and API-First Arnaud Lauret OpenAPI Tech Lead Ian Douglas Sr Developer Advocate
  • 36. Please ask questions throughout the day WE’RE HERE TO HELP https://go.pstmn.io/spacecamp-discord https://go.pstmn.io/spacecamp-notes
  • 38. All rights reserved by Postman Inc Session 3 and 4: Advanced API Workflows Arlemi Turpault Sr Developer Advocate Ian Douglas Sr Developer Advocate
  • 39. Please ask questions throughout the day WE’RE HERE TO HELP https://go.pstmn.io/spacecamp-discord https://go.pstmn.io/spacecamp-notes
  • 40. HEAD OF DEVELOPER ADVOCACY AND COMMUNITY, TWITTER Daniele Bernardi CHIEF EVANGELIST, POSTMAN Kin Lane @kinlane Fireside Chat: How Twitter Builds in the Open @i_am_daniele
  • 42. All rights reserved by Postman Inc Closing Thoughts Joyce Lin Director of Developer Relations