SlideShare a Scribd company logo
Design Driven APIs with Node.js and Swagger
Jeremy Whitlock (@whitlockjc)
Software Engineer
1
What is an API?
2
3
Need vectors of these elements
Need correct
heart
API Documentation
4
5
Need vectors of these elements
Need correct
heart
API Documentation is “Critical”
"While APIs are meant for
computers, applications, and
other systems, integrations all
begin with helping other humans
understand the what, and how of
what an API does, making API
docs a critical point in the API
journey."
6©2015 Apigee. All Rights Reserved.
7
Need vectors of these elements
Need correct
heart
If It Isn't Documented, It Doesn't Exist
“No matter how wonderful your library is and how
intelligent its design, if you're the only one who
understands it, it doesn't do any good. Documentation
means not just autogenerated API references, but also
annotated examples and in-depth tutorials. You need all
three to make sure your library can be easily adopted.”
8©2015 Apigee. All Rights Reserved.
Nicholas Zakas
http://blog.codinghorror.com/if-it-isnt-documented-it-doesnt-exist/
9
Need vectors of these elements
Need correct
heart
Good API Documentation
10©2015 Apigee. All Rights Reserved.
Good API Documentation
11
API Documentation should be easy to understand.
12
Need vectors of these elements
Need correct
heart
WHY ALL THE API DOCUMENTATION TALK?
Swagger
13
Sample Swagger Document
14©2015 Apigee. All Rights Reserved.
• Written in JSON or YAML
• Clearly describe:
• Available APIs
• API input contract
• API output contract
• Required authn/authz
• Success/Error responses
• …
• Extensible
Swagger Emerging as an Industry Standard
15©2015 Apigee. All Rights Reserved.
There is More to Swagger Than This!
16©2015 Apigee. All Rights Reserved.
How Do I Use Swagger?
17
Code Driven Swagger
18©2015 Apigee. All Rights Reserved.
Swagger
Duplication
Code Driven Swagger
19©2015 Apigee. All Rights Reserved.
Swagger
Swagger Driven Code
20©2015 Apigee. All Rights Reserved.
Emphasis slide
21
Before (43 lines) After (14 lines)
22
Need vectors of these elements
Need correct
heart
WHICH APPROACH IS BETTER?
Swagger Driven APIs
23
API Design
24
http://apistudio.io
API Design
25
http://apistudio.io
API Design
26
http://apistudio.io
27
Need vectors of these elements
Need correct
heart
Swagger Driven Node.js APIs
28
npm install -g swagger
Swagger Driven Node.js APIs
29
npm install -g swagger
Swagger
Swagger Metadata
Routing
Security
Request Validation
Response Validation
Business Logic
Thank You
30

More Related Content

What's hot (20)

PPTX
Building APIs with Apigee Edge and Microsoft Azure
Apigee | Google Cloud
 
PDF
API Copyrights: New Considerations for Building or Using APIs
Apigee | Google Cloud
 
PDF
Introduction to the Art of API Practice
Bill Doerrfeld
 
PDF
Orchestrating microservices like a ninja
Apigee | Google Cloud
 
PDF
How to scale 1000s of API Integrations and not lose your mind
Apigee | Google Cloud
 
PDF
apidays LIVE LONDON - OpenAPI-driven API development lifecycle at Adyen by Al...
apidays
 
PDF
A Checklist for Every API Call
Apigee | Google Cloud
 
PDF
API Design Workflows
Jakub Nesetril
 
PPTX
Executing on API Developer Experience
SmartBear
 
PDF
Coders Workshop: API First Mobile Development Featuring Angular and Node
Apigee | Google Cloud
 
PPTX
Pain Points In API Development? They’re Everywhere
Nordic APIs
 
PDF
Lessons Learned from Revamping Our Doc Site
Pronovix
 
PDF
Deep Dive: Strategic Importance of BaaS
Apigee | Google Cloud
 
PDF
INTERFACE, by apidays - Low code APIs that don't break by Zdenek Nemec, Supe...
apidays
 
PPTX
Node.js - Extending the Programmability of Apigee Edge
Apigee | Google Cloud
 
PDF
Deep-Dive: How Can APIs Help You Innovate? (Partner Ecosystems)
Apigee | Google Cloud
 
PPTX
Api-First service design
Stefaan Ponnet
 
PDF
Beyond the basic Swagger UI: Adyen API Explorer
Aleksei Akimov
 
PDF
apidays LIVE Hong Kong 2021 - Automating the API Product Lifecycle by Jeremy ...
apidays
 
PDF
apidays LIVE Australia 2021 - Confessions of a Product Geek : My First API BY...
apidays
 
Building APIs with Apigee Edge and Microsoft Azure
Apigee | Google Cloud
 
API Copyrights: New Considerations for Building or Using APIs
Apigee | Google Cloud
 
Introduction to the Art of API Practice
Bill Doerrfeld
 
Orchestrating microservices like a ninja
Apigee | Google Cloud
 
How to scale 1000s of API Integrations and not lose your mind
Apigee | Google Cloud
 
apidays LIVE LONDON - OpenAPI-driven API development lifecycle at Adyen by Al...
apidays
 
A Checklist for Every API Call
Apigee | Google Cloud
 
API Design Workflows
Jakub Nesetril
 
Executing on API Developer Experience
SmartBear
 
Coders Workshop: API First Mobile Development Featuring Angular and Node
Apigee | Google Cloud
 
Pain Points In API Development? They’re Everywhere
Nordic APIs
 
Lessons Learned from Revamping Our Doc Site
Pronovix
 
Deep Dive: Strategic Importance of BaaS
Apigee | Google Cloud
 
INTERFACE, by apidays - Low code APIs that don't break by Zdenek Nemec, Supe...
apidays
 
Node.js - Extending the Programmability of Apigee Edge
Apigee | Google Cloud
 
Deep-Dive: How Can APIs Help You Innovate? (Partner Ecosystems)
Apigee | Google Cloud
 
Api-First service design
Stefaan Ponnet
 
Beyond the basic Swagger UI: Adyen API Explorer
Aleksei Akimov
 
apidays LIVE Hong Kong 2021 - Automating the API Product Lifecycle by Jeremy ...
apidays
 
apidays LIVE Australia 2021 - Confessions of a Product Geek : My First API BY...
apidays
 

Viewers also liked (20)

PDF
Developers Hate Marketing! Driving API Adoption
Apigee | Google Cloud
 
PDF
Does your API need to be PCI Compliant?
Apigee | Google Cloud
 
PPTX
The API Facade Pattern: Technology - Episode 3
Apigee | Google Cloud
 
PDF
Real-time hypermedia APIs: Exploring the fundamentals of how we build network...
Apigee | Google Cloud
 
PDF
Your API Sucks! Why developers hang up and how to stop that.
Apigee | Google Cloud
 
PPTX
Mapping out your API Strategy - 4.20.11 Webinar slides
Apigee | Google Cloud
 
PPTX
APIs Inside Enterprise - SOA Displacement?
Apigee | Google Cloud
 
PPTX
O'Reilly author webinar "APIs: A Strategy guide": Transforming Your Business...
Apigee | Google Cloud
 
PDF
Edge API BaaS Deep-Dive: Streamline app development
Apigee | Google Cloud
 
KEY
Pragmatic RESTful API Design: Apigee Webinar
Apigee | Google Cloud
 
PDF
10 patterns in successful api programs 2
Apigee | Google Cloud
 
PPTX
Economic Models for Reinventing Telco - Innovation with APIs
Apigee | Google Cloud
 
PDF
Using APIs to Program Disparate IoT Devices
Apigee | Google Cloud
 
PDF
Create FHIR-Enabled Experiences: API-First Approach for Healthcare Apps
Apigee | Google Cloud
 
PPTX
Security as an Enabler for the Digital World - CISO Perspective
Apigee | Google Cloud
 
PPTX
API Management for Software Defined Network (SDN)
Apigee | Google Cloud
 
PDF
How to Achieve Agile API Security
Apigee | Google Cloud
 
PPTX
API Design - 3rd Edition
Apigee | Google Cloud
 
PDF
API Best Practices Webinar: Metrics - What to Measure
Apigee | Google Cloud
 
PPT
Why APIs are not SOA++
Apigee | Google Cloud
 
Developers Hate Marketing! Driving API Adoption
Apigee | Google Cloud
 
Does your API need to be PCI Compliant?
Apigee | Google Cloud
 
The API Facade Pattern: Technology - Episode 3
Apigee | Google Cloud
 
Real-time hypermedia APIs: Exploring the fundamentals of how we build network...
Apigee | Google Cloud
 
Your API Sucks! Why developers hang up and how to stop that.
Apigee | Google Cloud
 
Mapping out your API Strategy - 4.20.11 Webinar slides
Apigee | Google Cloud
 
APIs Inside Enterprise - SOA Displacement?
Apigee | Google Cloud
 
O'Reilly author webinar "APIs: A Strategy guide": Transforming Your Business...
Apigee | Google Cloud
 
Edge API BaaS Deep-Dive: Streamline app development
Apigee | Google Cloud
 
Pragmatic RESTful API Design: Apigee Webinar
Apigee | Google Cloud
 
10 patterns in successful api programs 2
Apigee | Google Cloud
 
Economic Models for Reinventing Telco - Innovation with APIs
Apigee | Google Cloud
 
Using APIs to Program Disparate IoT Devices
Apigee | Google Cloud
 
Create FHIR-Enabled Experiences: API-First Approach for Healthcare Apps
Apigee | Google Cloud
 
Security as an Enabler for the Digital World - CISO Perspective
Apigee | Google Cloud
 
API Management for Software Defined Network (SDN)
Apigee | Google Cloud
 
How to Achieve Agile API Security
Apigee | Google Cloud
 
API Design - 3rd Edition
Apigee | Google Cloud
 
API Best Practices Webinar: Metrics - What to Measure
Apigee | Google Cloud
 
Why APIs are not SOA++
Apigee | Google Cloud
 
Ad

Similar to I Love APIs 2015: Create Design-driven APIs with Node.js and Swagger (20)

PPTX
Building APIs with Node.js and Swagger
Jeremy Whitlock
 
PDF
PyCon PL 2014 executable api
Wojtek Erbetowski
 
PPTX
dod-api-meetup-03262015-swagger-docs
John O'Brien III
 
PDF
API Developer Experience: Why it Matters, and How Documenting Your API with S...
SmartBear
 
PDF
Design Driven API Development
Sokichi Fujita
 
PPTX
Swagger - make your API accessible
Victor Trakhtenberg
 
PDF
How to Create Developer-Friendly API Documentation
Cognith
 
PPTX
Everybody loves Swagger
BizTalk360
 
PPTX
API workshop: Introduction to APIs (TC Camp)
Tom Johnson
 
PDF
6 Best OpenAPI Documentation Tools that You must Know
Mars Devs
 
PPTX
Build APIs in Node.js and Swagger 2.0 with Apigee-127
Apigee | Google Cloud
 
PPTX
Everybody loves Swagger (Massimo Crippa @ Integration Monday)
Codit
 
PDF
Effective API Documentation Strategies (With an API Documentation Example
Perfect Documentation
 
PDF
I Love APIs Europe 2015: Developer Sessions
Apigee | Google Cloud
 
PPTX
Swagger for startups
Tony Tam
 
PDF
API Best Practices
EmmanuelParaskakis1
 
PPTX
Rest API with Swagger and NodeJS
Luigi Saetta
 
PPTX
PyBCN 2020
José Haro Peralta
 
PDF
Moving into API documentation writing
Ellis Pratt
 
Building APIs with Node.js and Swagger
Jeremy Whitlock
 
PyCon PL 2014 executable api
Wojtek Erbetowski
 
dod-api-meetup-03262015-swagger-docs
John O'Brien III
 
API Developer Experience: Why it Matters, and How Documenting Your API with S...
SmartBear
 
Design Driven API Development
Sokichi Fujita
 
Swagger - make your API accessible
Victor Trakhtenberg
 
How to Create Developer-Friendly API Documentation
Cognith
 
Everybody loves Swagger
BizTalk360
 
API workshop: Introduction to APIs (TC Camp)
Tom Johnson
 
6 Best OpenAPI Documentation Tools that You must Know
Mars Devs
 
Build APIs in Node.js and Swagger 2.0 with Apigee-127
Apigee | Google Cloud
 
Everybody loves Swagger (Massimo Crippa @ Integration Monday)
Codit
 
Effective API Documentation Strategies (With an API Documentation Example
Perfect Documentation
 
I Love APIs Europe 2015: Developer Sessions
Apigee | Google Cloud
 
Swagger for startups
Tony Tam
 
API Best Practices
EmmanuelParaskakis1
 
Rest API with Swagger and NodeJS
Luigi Saetta
 
PyBCN 2020
José Haro Peralta
 
Moving into API documentation writing
Ellis Pratt
 
Ad

More from Apigee | Google Cloud (20)

PDF
How Secure Are Your APIs?
Apigee | Google Cloud
 
PDF
Magazine Luiza at a glance (1)
Apigee | Google Cloud
 
PPTX
Monetization: Unlock More Value from Your APIs
Apigee | Google Cloud
 
PDF
Apigee Demo: API Platform Overview
Apigee | Google Cloud
 
PDF
Ticketmaster at a glance
Apigee | Google Cloud
 
PDF
AccuWeather: Recasting API Experiences in a Developer-First World
Apigee | Google Cloud
 
PDF
Which Application Modernization Pattern Is Right For You?
Apigee | Google Cloud
 
PPTX
Apigee Product Roadmap Part 2
Apigee | Google Cloud
 
PPTX
The Four Transformative Forces of the API Management Market
Apigee | Google Cloud
 
PDF
Walgreens at a glance
Apigee | Google Cloud
 
PDF
Apigee Edge: Intro to Microgateway
Apigee | Google Cloud
 
PDF
Managing the Complexity of Microservices Deployments
Apigee | Google Cloud
 
PDF
Pitney Bowes at a glance
Apigee | Google Cloud
 
PPTX
Microservices Done Right: Key Ingredients for Microservices Success
Apigee | Google Cloud
 
PDF
Adapt or Die: Opening Keynote with Chet Kapoor
Apigee | Google Cloud
 
PDF
Adapt or Die: Keynote with Greg Brail
Apigee | Google Cloud
 
PDF
Adapt or Die: Keynote with Anant Jhingran
Apigee | Google Cloud
 
PDF
London Adapt or Die: Opening Keynot
Apigee | Google Cloud
 
PDF
London Adapt or Die: Lunch keynote
Apigee | Google Cloud
 
PDF
London Adapt or Die: Closing Keynote — Adapt Now!
Apigee | Google Cloud
 
How Secure Are Your APIs?
Apigee | Google Cloud
 
Magazine Luiza at a glance (1)
Apigee | Google Cloud
 
Monetization: Unlock More Value from Your APIs
Apigee | Google Cloud
 
Apigee Demo: API Platform Overview
Apigee | Google Cloud
 
Ticketmaster at a glance
Apigee | Google Cloud
 
AccuWeather: Recasting API Experiences in a Developer-First World
Apigee | Google Cloud
 
Which Application Modernization Pattern Is Right For You?
Apigee | Google Cloud
 
Apigee Product Roadmap Part 2
Apigee | Google Cloud
 
The Four Transformative Forces of the API Management Market
Apigee | Google Cloud
 
Walgreens at a glance
Apigee | Google Cloud
 
Apigee Edge: Intro to Microgateway
Apigee | Google Cloud
 
Managing the Complexity of Microservices Deployments
Apigee | Google Cloud
 
Pitney Bowes at a glance
Apigee | Google Cloud
 
Microservices Done Right: Key Ingredients for Microservices Success
Apigee | Google Cloud
 
Adapt or Die: Opening Keynote with Chet Kapoor
Apigee | Google Cloud
 
Adapt or Die: Keynote with Greg Brail
Apigee | Google Cloud
 
Adapt or Die: Keynote with Anant Jhingran
Apigee | Google Cloud
 
London Adapt or Die: Opening Keynot
Apigee | Google Cloud
 
London Adapt or Die: Lunch keynote
Apigee | Google Cloud
 
London Adapt or Die: Closing Keynote — Adapt Now!
Apigee | Google Cloud
 

Recently uploaded (20)

PPTX
ManageIQ - Sprint 264 Review - Slide Deck
ManageIQ
 
PDF
Laboratory Workflows Digitalized and live in 90 days with Scifeon´s SAPPA P...
info969686
 
PDF
Continouous failure - Why do we make our lives hard?
Papp Krisztián
 
PPTX
CONCEPT OF PROGRAMMING in language .pptx
tamim41
 
PDF
Cloud computing Lec 02 - virtualization.pdf
asokawennawatte
 
PPTX
Perfecting XM Cloud for Multisite Setup.pptx
Ahmed Okour
 
PPTX
For my supp to finally picking supp that work
necas19388
 
PDF
From Chaos to Clarity: Mastering Analytics Governance in the Modern Enterprise
Wiiisdom
 
PPTX
Introduction to web development | MERN Stack
JosephLiyon
 
PPTX
EO4EU Ocean Monitoring: Maritime Weather Routing Optimsation Use Case
EO4EU
 
PDF
The Rise of Sustainable Mobile App Solutions by New York Development Firms
ostechnologies16
 
PPTX
CV-Project_2024 version 01222222222.pptx
MohammadSiddiqui70
 
PPTX
Iobit Driver Booster Pro 12 Crack Free Download
chaudhryakashoo065
 
PDF
Automated Test Case Repair Using Language Models
Lionel Briand
 
PDF
How DeepSeek Beats ChatGPT: Cost Comparison and Key Differences
sumitpurohit810
 
PPTX
IObit Uninstaller Pro 14.3.1.8 Crack Free Download 2025
sdfger qwerty
 
PDF
>Wondershare Filmora Crack Free Download 2025
utfefguu
 
PDF
TEASMA: A Practical Methodology for Test Adequacy Assessment of Deep Neural N...
Lionel Briand
 
PPTX
Seamless-Image-Conversion-From-Raster-to-wrt-rtx-rtx.pptx
Quick Conversion Services
 
PDF
IObit Uninstaller Pro 14.3.1.8 Crack for Windows Latest
utfefguu
 
ManageIQ - Sprint 264 Review - Slide Deck
ManageIQ
 
Laboratory Workflows Digitalized and live in 90 days with Scifeon´s SAPPA P...
info969686
 
Continouous failure - Why do we make our lives hard?
Papp Krisztián
 
CONCEPT OF PROGRAMMING in language .pptx
tamim41
 
Cloud computing Lec 02 - virtualization.pdf
asokawennawatte
 
Perfecting XM Cloud for Multisite Setup.pptx
Ahmed Okour
 
For my supp to finally picking supp that work
necas19388
 
From Chaos to Clarity: Mastering Analytics Governance in the Modern Enterprise
Wiiisdom
 
Introduction to web development | MERN Stack
JosephLiyon
 
EO4EU Ocean Monitoring: Maritime Weather Routing Optimsation Use Case
EO4EU
 
The Rise of Sustainable Mobile App Solutions by New York Development Firms
ostechnologies16
 
CV-Project_2024 version 01222222222.pptx
MohammadSiddiqui70
 
Iobit Driver Booster Pro 12 Crack Free Download
chaudhryakashoo065
 
Automated Test Case Repair Using Language Models
Lionel Briand
 
How DeepSeek Beats ChatGPT: Cost Comparison and Key Differences
sumitpurohit810
 
IObit Uninstaller Pro 14.3.1.8 Crack Free Download 2025
sdfger qwerty
 
>Wondershare Filmora Crack Free Download 2025
utfefguu
 
TEASMA: A Practical Methodology for Test Adequacy Assessment of Deep Neural N...
Lionel Briand
 
Seamless-Image-Conversion-From-Raster-to-wrt-rtx-rtx.pptx
Quick Conversion Services
 
IObit Uninstaller Pro 14.3.1.8 Crack for Windows Latest
utfefguu
 

I Love APIs 2015: Create Design-driven APIs with Node.js and Swagger