SlideShare a Scribd company logo
Standardizing APIs Across Your
Organization with Swagger and OAS
Proprietary & Confidential
Jonathan Fortunati
Solutions Engineering Manager
SmartBear
Patrick Londa
Marketing Manager
SmartBear
Your Hosts for Today
Agenda
1. Introduction
2. Why Standardization is Critical
3. Defining Quality for Your Team
4. Challenges of OAS Development at Scale
5. How SwaggerHub Can Help
6. Time for Q&A
Proprietary & Confidential
Introduction
We provide tools for development, testing, and operations
teams to create great software, faster than ever.
• HQ in Boston, MA, USA, with 7 offices globally
• Founded in 2009
• Open Source Innovator (Swagger & SoapUI)
6.5M+
Users
194
Countries
22K+
Companies
TestComplete
SoapUI Pro
SwaggerHub
CrossBrowserTesting
QAComplete
AlertSite
Design Commit Test Deploy Monitor
Manage
UI
API
Collaborate on user stories,
tests, and code
Commit and push new code and
tests to kick off CI
Create, manage, and execute
automated tests
Deploy to production once
tests and builds pass
Monitor the performance
of your APIs and web apps
Analyze and improve all of your testing
Reduce defects and improve trust with code review
SwaggerHub
Design, model, & share
API definitions
CucumberStudio
Design features & tests
using BDD
Zephyr Native Jira & enterprise test management
Review
Collaborator Code, document, & artifact review
CrossBrowserTesting
Run Selenium & Appium tests in the cloud
LoadNinja
Automated UI performance testing
TestComplete
Automated UI functional testing
ServiceV Pro
Virtualize APIs, UIs, and web services
LoadUI Pro
Automated API performance testing
SoapUI Pro
Automated API functional & security testing
AlertSite
Global, synthetic API monitoring
Accelerate & manage API functional testing
Test mobile apps on real devices in the cloud
BitBar
Why Standardization is Critical
The 2019 State of API Report
Quality is King
API consumers expect efficient, high performance
services that are easy to use.
API developers recognize quality as a top priority.
 41.5% say it is ‘Extremely Important’
 78.5% say it is ‘Very Important’ or higher
Poor API quality has real consequences.
 45% relate poor quality to potential loss of customers
 48% worry about damaging company reputation
Standards Enforce Quality
Standardization is the #1 challenge teams are looking to
overcome in the new year.
Versioning and re-use also important considerations, with
speed being a key driver.
Over 50% of organizations use, or plan on using an
internal style guideline.
Style guidelines were ‘important’ or higher for over 50% of
respondents.
Defining Quality for Your Team
Reusable
Components
Shifting Left
Driven by the OAS Document &
Consumer
The OpenAPI specification is the
industry standard for designing
and building quality RESTful APIs
and SmartBear is a leading
sponsor of the project
Enable shift-left transformation
through definition-driven
development, virtualizing and
testing definitions before code is
written.
Improve efficiency by sharing API
definitions, virtual services, and
code snippets throughout your
development lifecycle for
maximum reuse.
We believe documentation is at
the core of a consumable,
shareable API that fosters a
positive experience in the
developer community.
12
Phase 1
Individual Devs Write or
Generate OpenAPI
Definitions
Phase 2
More People Get Involved
and All New APIs Have OAS
Phase 3
New Processes and Tooling
Need to Be Implemented
3 Phases of OAS Development
13
OAS Development Challenges
1. Too many versions of too many specs in too many places
2. Too many people involved that need to collaborate and share
3. Loss of control and visibility into API design process
4. Integrating API development into existing delivery pipeline
Swaggerhub
A platform that ties together all the open source Swagger
tools in one place.
• SwaggerUI
• Swagger Editor
• Swagger Codegen
Creates a single source of truth for distributed services.
Provides structure and guidance across teams:
• Team / Organization Management
• API Standardization Checks
• Domains
{ }…
15
Challenge 1:
Too many versions of too many specs in too many places
A central ‘hub’ for designing + documenting APIs:
 Allow teams to work together on a core piece of their
development
 Resolve issues sooner with more input from consumers,
users and other teams
 Initiate a significant return on investment
Plan Design Develop Test Monitor
$0 $0 $100 $250 $1500
COST OF RESOLVING DEFECTS
16
Challenge 2:
Too many people involved that need to collaborate and share
Work in teams and foster cross-functional feedback:
 Bring in the right stakeholders early to create consensus
and reduce rework
 Organize users into different teams and projects
 Assign access and permissions as needed
{ }…
17
Challenge 3:
Loss of control and visibility into API design process
Set standards and ensure compliance while designing:
 Define API standards in one place and enforce across
your organization without manual validation
 Supplement your style guide with custom rules that
might be unique to your industry
 Create a library of reusable assets to ensure
consistency and reduce design duplication
18
Challenge 4:
Integrating API development into existing delivery pipeline
Connect across your API lifecycle with integrations:
 Keep source code in sync with API designs
 Push APIs to API gateways like Azure, AWS, and Apigee
for consumption
 Leverage your API contract in your CI/CD pipeline
Q + A
Thank You!

More Related Content

PPTX
Getting Started with API Standardization in SwaggerHub
PPTX
Effective API Lifecycle Management
PDF
The API Lifecycle Series: Evolving API Development and Testing from Open Sour...
PPTX
How LISI Automotive Accelerated Application Delivery with SwaggerHub
PPTX
Adopting a Design-First Approach to API Development with SwaggerHub
PPTX
Standardising APIs: Powering the Platform Economy in Financial Services
PDF
The API Lifecycle Series: Exploring Design-First and Code-First Approaches to...
PPTX
IATA Open Air: How API Standardization Enables Innovation in the Airline Indu...
Getting Started with API Standardization in SwaggerHub
Effective API Lifecycle Management
The API Lifecycle Series: Evolving API Development and Testing from Open Sour...
How LISI Automotive Accelerated Application Delivery with SwaggerHub
Adopting a Design-First Approach to API Development with SwaggerHub
Standardising APIs: Powering the Platform Economy in Financial Services
The API Lifecycle Series: Exploring Design-First and Code-First Approaches to...
IATA Open Air: How API Standardization Enables Innovation in the Airline Indu...

What's hot (20)

PPTX
API Docs with OpenAPI 3.0
PPTX
Introducing OpenAPI Version 3.1
PPTX
Understanding and Executing on API Developer Experience
PDF
Bulletproofing Your APIs: Why Users’ Feedback Matters
PPTX
The State of Testing 2017
PDF
Rest api best practices – comprehensive handbook
PDF
An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesf...
PDF
INTERFACE, by apidays - Low code APIs that don't break by Zdenek Nemec, Supe...
PPTX
Use Automation to Assist -Not Replace- Manual Testing
PPTX
Advanced Mocking for Swagger APIs
PPTX
apidays LIVE LONDON - Unlock the Power of OAS in the Last Mile of your Lifecy...
PDF
{Re}designing a Developer Portal
PDF
Engineer Stunning (API) documentation
PPTX
Guide to an API-first Strategy
PDF
Wso2 italia Open Break session #7 - Test di API e microservizi nelle architet...
PDF
Can virtualization transform your API lifecycle?
PPTX
apidays LIVE LONDON - Discovering API Version differences with ease by Jaap B...
PDF
Why You Need a Developer Relations Team for Your API
PPT
apidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypal
PDF
apidays LIVE Paris 2021 - Spatially enabling Web APIs through OGC Standards ...
API Docs with OpenAPI 3.0
Introducing OpenAPI Version 3.1
Understanding and Executing on API Developer Experience
Bulletproofing Your APIs: Why Users’ Feedback Matters
The State of Testing 2017
Rest api best practices – comprehensive handbook
An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesf...
INTERFACE, by apidays - Low code APIs that don't break by Zdenek Nemec, Supe...
Use Automation to Assist -Not Replace- Manual Testing
Advanced Mocking for Swagger APIs
apidays LIVE LONDON - Unlock the Power of OAS in the Last Mile of your Lifecy...
{Re}designing a Developer Portal
Engineer Stunning (API) documentation
Guide to an API-first Strategy
Wso2 italia Open Break session #7 - Test di API e microservizi nelle architet...
Can virtualization transform your API lifecycle?
apidays LIVE LONDON - Discovering API Version differences with ease by Jaap B...
Why You Need a Developer Relations Team for Your API
apidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypal
apidays LIVE Paris 2021 - Spatially enabling Web APIs through OGC Standards ...
Ad

Similar to Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBear Webinar (20)

PPTX
Enforcing Your Organization's API Design Standards with SwaggerHub
PDF
apidays LIVE Paris 2021 - 5 Learnings Shaping Our View on the Future of APIs ...
PDF
Spec-first API Design for Speed and Safety
PPTX
The Swagger Format becomes the Open API Specification: Standardizing descript...
PDF
LF_APIStrat17_Your API Spec is a Contract, So Test It Like One!
PDF
Always up to date, testable and maintainable documentation with OpenAPI
PDF
apidays LIVE Helsinki & North 2022_Building an Accessible API Spec with Tradi...
PDF
LF_APIStrat17_Creating an API Ecosystem that Benefits Producers and Consumers
PDF
INTERFACE, by apidays - Scaling APIs
PDF
apidays LIVE Paris 2021 - Building an Accessible API Spec with Traditional En...
PDF
INTERFACE, by apidays - Building an Accessible API Spec
PDF
Presentation at the 2016 Linux Foundation Collab Summit
PPTX
Swagger - Making REST APIs friendlier
PDF
Designing APIs with OpenAPI Spec
PDF
Designing APIs with Swagger and OpenAPI 1st Edition Joshua S. Ponelat
PPTX
The relevance of design principles for WEB APIs
PPTX
Make Your Contribution Count. Adding Value to the API as a Technical Communic...
PDF
"API Design: From User Need to Finished Spec" by Andrew Jordan, ex-Product @T...
PDF
Api design best practice
PDF
#APIOps- Agile API Development powered by API Connect
Enforcing Your Organization's API Design Standards with SwaggerHub
apidays LIVE Paris 2021 - 5 Learnings Shaping Our View on the Future of APIs ...
Spec-first API Design for Speed and Safety
The Swagger Format becomes the Open API Specification: Standardizing descript...
LF_APIStrat17_Your API Spec is a Contract, So Test It Like One!
Always up to date, testable and maintainable documentation with OpenAPI
apidays LIVE Helsinki & North 2022_Building an Accessible API Spec with Tradi...
LF_APIStrat17_Creating an API Ecosystem that Benefits Producers and Consumers
INTERFACE, by apidays - Scaling APIs
apidays LIVE Paris 2021 - Building an Accessible API Spec with Traditional En...
INTERFACE, by apidays - Building an Accessible API Spec
Presentation at the 2016 Linux Foundation Collab Summit
Swagger - Making REST APIs friendlier
Designing APIs with OpenAPI Spec
Designing APIs with Swagger and OpenAPI 1st Edition Joshua S. Ponelat
The relevance of design principles for WEB APIs
Make Your Contribution Count. Adding Value to the API as a Technical Communic...
"API Design: From User Need to Finished Spec" by Andrew Jordan, ex-Product @T...
Api design best practice
#APIOps- Agile API Development powered by API Connect
Ad

More from SmartBear (20)

PPTX
The State of API 2020 Webinar – Exploring Trends, Tools & Takeaways to Drive ...
PPTX
Artificial intelligence for faster and smarter software testing - Galway Mee...
PDF
Successfully Implementing BDD in an Agile World
PPTX
The Best Kept Secrets of Code Review | SmartBear Webinar
PPTX
How Capital One Scaled API Design to Deliver New Products Faster
PPTX
Testing Without a GUI Using TestComplete
PPTX
Hidden Treasure - TestComplete Script Extensions
PDF
How Bdd Can Save Agile
PPTX
API Automation and TDD to Implement Master Data Survivorship Rules
PDF
Support Rapid Systems Growth with a Design-First Approach
PDF
Maximize Test Automation with a Risk-Based Approach
PPTX
Modernizing the Enterprise API Development Process
PPTX
Developing Performance-Oriented Code: Moore's Law Over 50
PPTX
Implementation of DevOps at SmartBear
PPTX
Accelerate Your Delivery Pipeline with Continuous Testing
PPTX
Be Dynamic: Unblock Your Environments
PPTX
Transform QA to Stay Ahead of Digital Disruption
PPTX
The Keys to Code Review in 2018 | A SmartBear Webinar
PDF
Testing the Front-End, Back-End, and Everything in Between
PDF
2018 State of Testing Survey Results
The State of API 2020 Webinar – Exploring Trends, Tools & Takeaways to Drive ...
Artificial intelligence for faster and smarter software testing - Galway Mee...
Successfully Implementing BDD in an Agile World
The Best Kept Secrets of Code Review | SmartBear Webinar
How Capital One Scaled API Design to Deliver New Products Faster
Testing Without a GUI Using TestComplete
Hidden Treasure - TestComplete Script Extensions
How Bdd Can Save Agile
API Automation and TDD to Implement Master Data Survivorship Rules
Support Rapid Systems Growth with a Design-First Approach
Maximize Test Automation with a Risk-Based Approach
Modernizing the Enterprise API Development Process
Developing Performance-Oriented Code: Moore's Law Over 50
Implementation of DevOps at SmartBear
Accelerate Your Delivery Pipeline with Continuous Testing
Be Dynamic: Unblock Your Environments
Transform QA to Stay Ahead of Digital Disruption
The Keys to Code Review in 2018 | A SmartBear Webinar
Testing the Front-End, Back-End, and Everything in Between
2018 State of Testing Survey Results

Recently uploaded (20)

PPTX
Introduction to Pathology.pptx 112233445566
PDF
Key Trends in Website Development 2025 | B3AITS - Bow & 3 Arrows IT Solutions
PDF
Design Thinking - Module 1 - Introduction To Design Thinking - Dr. Rohan Dasg...
PPTX
BSCS lesson 3.pptxnbbjbb mnbkjbkbbkbbkjb
PPTX
KOTA LAMA BANYUMAS.pptxxxxxxxxxxxxxxxxxxxx
PDF
Benefits_of_Cast_Aluminium_Doors_Presentation.pdf
PPTX
Special finishes, classification and types, explanation
PPTX
6- Architecture design complete (1).pptx
PPTX
building Planning Overview for step wise design.pptx
PDF
10 Real World Lessons and 4 Practical Tips for Large Group LSP Method
PDF
Emailing DDDX-MBCaEiB.pdf DDD_Europe_2022_Intro_to_Context_Mapping_pdf-165590...
PPTX
Lecturess 1 & 2_2025_edit.pptxYour score increases as you pick a category, fi...
PPT
unit 1 ppt.ppthhhhhhhhhhhhhhhhhhhhhhhhhh
PDF
Facade & Landscape Lighting Techniques and Trends.pptx.pdf
PDF
URBAN DESIGN DESKTOP CASESTUDY IITG.pdf
DOCX
actividad 20% informatica microsoft project
PPT
Package Design Design Kit 20100009 PWM IC by Bee Technologies
PDF
Trusted Executive Protection Services in Ontario — Discreet & Professional.pdf
PPTX
AD Bungalow Case studies Sem 2.pptxvwewev
PPTX
TLE-10-PPTHAJAOSBDJDEKSNbknbtktktmktkttk
Introduction to Pathology.pptx 112233445566
Key Trends in Website Development 2025 | B3AITS - Bow & 3 Arrows IT Solutions
Design Thinking - Module 1 - Introduction To Design Thinking - Dr. Rohan Dasg...
BSCS lesson 3.pptxnbbjbb mnbkjbkbbkbbkjb
KOTA LAMA BANYUMAS.pptxxxxxxxxxxxxxxxxxxxx
Benefits_of_Cast_Aluminium_Doors_Presentation.pdf
Special finishes, classification and types, explanation
6- Architecture design complete (1).pptx
building Planning Overview for step wise design.pptx
10 Real World Lessons and 4 Practical Tips for Large Group LSP Method
Emailing DDDX-MBCaEiB.pdf DDD_Europe_2022_Intro_to_Context_Mapping_pdf-165590...
Lecturess 1 & 2_2025_edit.pptxYour score increases as you pick a category, fi...
unit 1 ppt.ppthhhhhhhhhhhhhhhhhhhhhhhhhh
Facade & Landscape Lighting Techniques and Trends.pptx.pdf
URBAN DESIGN DESKTOP CASESTUDY IITG.pdf
actividad 20% informatica microsoft project
Package Design Design Kit 20100009 PWM IC by Bee Technologies
Trusted Executive Protection Services in Ontario — Discreet & Professional.pdf
AD Bungalow Case studies Sem 2.pptxvwewev
TLE-10-PPTHAJAOSBDJDEKSNbknbtktktmktkttk

Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBear Webinar

  • 1. Standardizing APIs Across Your Organization with Swagger and OAS
  • 2. Proprietary & Confidential Jonathan Fortunati Solutions Engineering Manager SmartBear Patrick Londa Marketing Manager SmartBear Your Hosts for Today
  • 3. Agenda 1. Introduction 2. Why Standardization is Critical 3. Defining Quality for Your Team 4. Challenges of OAS Development at Scale 5. How SwaggerHub Can Help 6. Time for Q&A Proprietary & Confidential
  • 5. We provide tools for development, testing, and operations teams to create great software, faster than ever. • HQ in Boston, MA, USA, with 7 offices globally • Founded in 2009 • Open Source Innovator (Swagger & SoapUI) 6.5M+ Users 194 Countries 22K+ Companies TestComplete SoapUI Pro SwaggerHub CrossBrowserTesting QAComplete AlertSite
  • 6. Design Commit Test Deploy Monitor Manage UI API Collaborate on user stories, tests, and code Commit and push new code and tests to kick off CI Create, manage, and execute automated tests Deploy to production once tests and builds pass Monitor the performance of your APIs and web apps Analyze and improve all of your testing Reduce defects and improve trust with code review SwaggerHub Design, model, & share API definitions CucumberStudio Design features & tests using BDD Zephyr Native Jira & enterprise test management Review Collaborator Code, document, & artifact review CrossBrowserTesting Run Selenium & Appium tests in the cloud LoadNinja Automated UI performance testing TestComplete Automated UI functional testing ServiceV Pro Virtualize APIs, UIs, and web services LoadUI Pro Automated API performance testing SoapUI Pro Automated API functional & security testing AlertSite Global, synthetic API monitoring Accelerate & manage API functional testing Test mobile apps on real devices in the cloud BitBar
  • 8. The 2019 State of API Report
  • 9. Quality is King API consumers expect efficient, high performance services that are easy to use. API developers recognize quality as a top priority.  41.5% say it is ‘Extremely Important’  78.5% say it is ‘Very Important’ or higher Poor API quality has real consequences.  45% relate poor quality to potential loss of customers  48% worry about damaging company reputation
  • 10. Standards Enforce Quality Standardization is the #1 challenge teams are looking to overcome in the new year. Versioning and re-use also important considerations, with speed being a key driver. Over 50% of organizations use, or plan on using an internal style guideline. Style guidelines were ‘important’ or higher for over 50% of respondents.
  • 11. Defining Quality for Your Team Reusable Components Shifting Left Driven by the OAS Document & Consumer The OpenAPI specification is the industry standard for designing and building quality RESTful APIs and SmartBear is a leading sponsor of the project Enable shift-left transformation through definition-driven development, virtualizing and testing definitions before code is written. Improve efficiency by sharing API definitions, virtual services, and code snippets throughout your development lifecycle for maximum reuse. We believe documentation is at the core of a consumable, shareable API that fosters a positive experience in the developer community.
  • 12. 12 Phase 1 Individual Devs Write or Generate OpenAPI Definitions Phase 2 More People Get Involved and All New APIs Have OAS Phase 3 New Processes and Tooling Need to Be Implemented 3 Phases of OAS Development
  • 13. 13 OAS Development Challenges 1. Too many versions of too many specs in too many places 2. Too many people involved that need to collaborate and share 3. Loss of control and visibility into API design process 4. Integrating API development into existing delivery pipeline
  • 14. Swaggerhub A platform that ties together all the open source Swagger tools in one place. • SwaggerUI • Swagger Editor • Swagger Codegen Creates a single source of truth for distributed services. Provides structure and guidance across teams: • Team / Organization Management • API Standardization Checks • Domains { }…
  • 15. 15 Challenge 1: Too many versions of too many specs in too many places A central ‘hub’ for designing + documenting APIs:  Allow teams to work together on a core piece of their development  Resolve issues sooner with more input from consumers, users and other teams  Initiate a significant return on investment Plan Design Develop Test Monitor $0 $0 $100 $250 $1500 COST OF RESOLVING DEFECTS
  • 16. 16 Challenge 2: Too many people involved that need to collaborate and share Work in teams and foster cross-functional feedback:  Bring in the right stakeholders early to create consensus and reduce rework  Organize users into different teams and projects  Assign access and permissions as needed { }…
  • 17. 17 Challenge 3: Loss of control and visibility into API design process Set standards and ensure compliance while designing:  Define API standards in one place and enforce across your organization without manual validation  Supplement your style guide with custom rules that might be unique to your industry  Create a library of reusable assets to ensure consistency and reduce design duplication
  • 18. 18 Challenge 4: Integrating API development into existing delivery pipeline Connect across your API lifecycle with integrations:  Keep source code in sync with API designs  Push APIs to API gateways like Azure, AWS, and Apigee for consumption  Leverage your API contract in your CI/CD pipeline
  • 19. Q + A Thank You!