INTERFACE, by apidays - APIs: the next 10 years
June 8, 9 & 10 2022
How to Win Friends and Influence People with API First
Arlemi Turpault, Senior Developer Advocate at Postman
------------
Check out our conferences at https://www.apidays.global/
Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Deep dive into the API industry with our reports:
https://www.apidays.global/industry-reports/
Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW
INTERFACE, by apidays - How to Win Friends and Influence People with API First
1. All rights reserved by Postman Inc
How to Win Friends
and Influence People
with API First
Arlemi Turpault
Senior Developer Advocate
2. 2022 SERIES OF EVENTS
New York
JULY
(HYBRID)
Australia
SEPTEMBER
(HYBRID)
Singapore
APRIL
(VIRTUAL)
Helsinki & North
MARCH
(VIRTUAL)
Paris
DECEMBER
(HYBRID)
London
OCTOBER
(HYBRID)
Hong Kong
AUGUST
(VIRTUAL)
JUNE (VIRTUAL)
India
MAY
(VIRTUAL)
APRIL (VIRTUAL)
Dubai & Middle East
JUNE
(VIRTUAL)
Check out our API Conferences
www.a pida ys .globa l
Want to talk at one of our conferences?
apidays.typeform.com/to/ILJeAaV8
9. All of the code that was built for
the website then had to be
rebuilt in our API to be used by
our iOS and Android apps.
Stephanie Schirmer
Etsy
“
@arlemi
13. Problems with a traditional code-first approach
● Bottlenecks delay contributors and consumers
● Rework late in the development cycle
● Building stuff no one wants
● End product is inadequately documented
● API is constrained by the data model and business logic
How not to make friends
@arlemi
15. Benefits of an API-first approach
● Earlier validation
● Decoupling dependencies
● Faster growth
● Freedom from constraints
How to make friends
@arlemi
16. A single team should not become a bottleneck nor
need to have expertise on every client application
to create optimized endpoints. Rapid innovation
through fast, decoupled development cycles across
a wide variety of device types and distributed
ownership and expertise across teams should be
enabled.
Ben Christensen
Netflix
“
@arlemi
18. API-First
schema
API-first
Defining and
designing APIs and
schema before
development
interface
API-first
Developing APIs
before developing
applications or
integrations
business
requirements
API-first
Defining business
requirements before
defining and
designing APIs
33%
39%
14%
@arlemi
20. API-First
schema
API-first
Defining and
designing APIs and
schema before
development
interface
API-first
Developing APIs
before developing
applications or
integrations
business
requirements
API-first
Defining business
requirements before
defining and
designing APIs
33%
39%
14%
@arlemi
22. Common API-first tools and workflows
● API specifications
● Mock servers
● Consumer-driven contract (CDC) testing
How do you transform a cluttered API
development workflow?
@arlemi
29. Mock Servers
for prototyping new services
Generated from API specification
Based on paired requests and responses (examples)
for each endpoint
@arlemi
Prototype new services
Enables parallel development using the mock
endpoints
32. CDC testing
for ensuring providers fulfill consumer expectations
@arlemi
Provider issues specification
Provider proposes the terms of the contract in the
specification
33. CDC testing
for ensuring providers fulfill consumer expectations
Consumers write tests
Consumers test only the endpoints and properties
they consume
@arlemi
Provider issues specification
Provider proposes the terms of the contract in the
specification
34. CDC testing
for ensuring providers fulfill consumer expectations
Consumers write tests
Consumers test only the endpoints and properties
they consume
@arlemi
Provider issues specification
Provider proposes the terms of the contract in the
specification
Contract
Explicit agreement about how the API will be used
between provider and consumers
35. CDC testing
for ensuring providers fulfill consumer expectations
Consumers write tests
Consumers test only the endpoints and properties
they consume
@arlemi
Provider issues specification
Provider proposes the terms of the contract in the
specification
Contract
Explicit agreement about how the API will be used
between provider and consumers
Provider runs tests
Provider runs consumers’ tests as part of their
deployment pipeline
36. API-first workflow for Postman ENG
mock servers
Parallel Development
Generate mocks to
enable parallel
development
CDC testing
CI/CD
Ensure no breaking
changes for
microservices
specification
Blueprint
Blueprint collection
to propose a new
API
@arlemi
38. Various meanings of API-First
● API-first development: when developing new functionality, the
functionality should first be exposed as an API in your organization
● API-first design: planning the functionality (specification)
○ What functionality will the API have?
○ What data will it expose?
○ What will the developer experience be like?
○ How will it scale?
○ How will we add new functionality in the future?
What does API-first mean to you?
@arlemi
39. Using an API-first approach can give you:
● Earlier validation
● Decoupling dependencies
● Faster growth
● Freedom from constraints
Benefits of an API-first approach
@arlemi
43. 2021 State of the API Report
API-first Software Development for Modern Organizations
Bringing law and order to APIs with OpenAPI Specifications
Using Mock Servers throughout the API Lifecycle
Design and Prototype an API in Postman - Webinar
1
2
3
4
Additional Resources
5
@arlemi