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

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

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

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

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

Recommended

More Related Content

What's hot (20)

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

More from SmartBear (20)

Recently uploaded (20)

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