Space Camp June 2022 - API First.pdf

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

Welcome to
API-First!
W. Ian Douglas
Sr Developer Advocate

Introducing API-First
and, Why do API-First
LEVEL-SETTING

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

It’s a “Mindset” Define
Design
Document
Test

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

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 …

● 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.

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?

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

● 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

Developer Advocacy, Stripe
@cjav_dev
34
API feature lifecycle
CJ Avilla
Welcome!

Session 2:
Applying OpenAPI
and API-First
Arnaud Lauret
OpenAPI Tech Lead
Ian Douglas

Let’s Recap
Feedback
https://go.pstmn.io/sc-feedback-am

Session 3 and 4:
Advanced API
Workflows
Arlemi Turpault
Ian Douglas

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

Closing Thoughts
Joyce Lin
Director of Developer Relations

Space Camp June 2022 - API First.pdf

More Related Content

Similar to Space Camp June 2022 - API First.pdf

More from Postman

Recently uploaded

Space Camp June 2022 - API First.pdf