The API Economy and How to Optimize Your Organization's Swagger API Workflow

Get started for free: swaggerhub.com
The API Economy and How to
Optimize Your Organization's
Swagger API Workflow

Presented by…
Product Marketing Manager, SwaggerHub
Keshav Vasudevan
@swaggerhub
SwaggerHub is a cloud-based platform, created by the team behind the
open source Swagger tools, to build, document, and deploy your API.
SwaggerHub integrates the functionality of the open source Swagger Editor,
Swagger UI, and Swagger CodeGen and offers additional capabilities teams
need to build great APIs.

Agenda
•Understanding the API economy
•Business opportunities presented by APIs
•Deciding on the right approach to API
development
•Optimizing the API workflow with SwaggerHub

Welcome to the API Economy

The rise in APIs
•APIs serve a basic need – a better way to share
information and enable transactions
•APIs have been around for 30 years – were
primarily viewed as technical assets
•Internet – social media, ecommerce, digital
transactions etc. along multiple device
ecosystem has driven change in API purpose
•APIs have emerged as a distribution channel for
business and technological needs

APIs are everywhere!

Number of connected devices
No. of devices/person
In 2020
7 devices

What is the API Economy?
•The API Economy is a general term that
describes how APIs help drive organization’s
profitability
•About using APIs as sources of strategic value
and financial impact
•Rethinking business models to incorporate API
for meeting their objectives

Business opportunities
presented by APIs

Driving the way forward with APIs
•Multiple platform support is the foundation of a
good application strategy
•They open new revenue channels by linking
applications, services and systems with APIs
Turning business ideas into an actual platform will need API
API

1 in 5 API providers developed APIs in the last 5 years
0%
5%
10%
15%
20%
25%
30%
35%
Less than a year 1-2 years 3-5 years 6-10 years More than 10 years
How long have vendors been developing APIs
Source: SmartBear State of API report, 2016

The types of API programs
•Two types of API programs
•Closed, “partner-only” API model, where only
partners have access to APIs
•Open, “all-public” API model, where anyone can
use the API for a fixed no. of transactions

The closed API model
•Facilitate communication and integration
between company and its business partners
•Relies on hand-crafted partnerships
•May also have developers share details of
Integration idea before becoming partner
•Should establish multiple tiers of API access,
within developer ecosystem
•Centers around identifying the best devs and
app within API ecosystem that businesses can
leverage

Advantages of partner based API model
•Monetize information exhaust
•Create new business streams and revenue
channels
•Help existing partners get access to raw and
richer data
•Controlled data access to have better say on
how the data gets used

Examples of partnership based API programs
- Pays partner org bounty for Uber sign up
- Amazon Associates Program gets profit from
sales driven to Amazon
- Allows developers, registering and getting a
revenue share in the commerce they bring to
the network

The Open, Public API model
•Allow exposing of information and functionalities
to third parties that don’t necessarily have a
business relationship
•More of a “classic” model
•Companies with large users and sources of
public information tend to have a public APIs
•Allows a fixed number of API calls per unit time
• Should be supported by good analytical and
management tools
•Should be in a position to handle large loads

Advantages of public API model
•Innovation opportunities that present itself
•New markets that cannot be accessed via other
business strategies
•Opens up global business opportunities
•Encourages third party to create value added
products to increase functionality and use
cases. Eg: Twitter
•Allow permeation of product in application
ecosystem. Eg: Facebook

Great success stories – API Provider
https://www.programmableweb.com/apis/directory

Great success stories – API Consumer
- Seamless integrations with tons of apps
https://slack.com/apps
- 200 million messages/day
- 2.7 million active users/day
- Built on the Google APIs API
- Over one million daily rides
- Uses Twilio for its in-built calling
- Over 100 million voice calls/day
- Over one billion users

How Swagger framework fits in
to your API strategy

Swagger is the contract for your API
•Swagger is an API framework, that allows users
to
–Design
–Build
–Document
•Swagger defines your API’s contract
•Connects computers, technology stacks and
humans in one unified language

Example of a Swagger API Contract

Example of Documentation

Optimizing the organization’s
Swagger workflow

The API lifecycle
•Developing APIs is no easy task
•Taking APIs from concept to retirement
encompasses the entire API lifecycle
•Each aspect of the lifecycle needs to be treated
with care
•An optimal strategy for each aspect would need
to figured out based on organization

Two approaches to building APIs
•Two approaches to building Swagger based
APIs
•Design First:
–Design API contract first
–Done before writing any API code
–Primary focus on consumption and integration experience of
consumers
•Code First:
–More traditional form of API development
–Code is written first
–Contract and documentation generated after API is functioning

Understanding them better
Design First
(option 1)
Code First
(option 2)
Business
opportunity
Strategic
document
Contract
Code the API
Contract/
Document
ation
Code the API

Why Design First is an optimal strategy
•APIs are to be built for consumers – Design
First advocates engineering a great user
experience first
•Ensures better quality
•Testing and integration becomes straightforward
•Helps facilitate better communication
•Documentation and development can happen
simultaneously

The API Workflow
Design
Develop
Deploy
Retire
Plan
The API Lifecycle

SwaggerHub is the center of your API lifecycle
Design
Implementation
Testing
Mocking
Documentation
Virtualization
Deployment /
Runtime
Clients
Configure AWS API
Gateway deployment
Developer portals,
Code samples, User guides
Functional / Runtime simulations
Functional, Security,
Load, Compliance
Generate AWS Lambda functions / configurations
Prototyping
30+ languages
Collaborative, Integrated

Demo

The proposed API workflow
Plan Design
Develop
Document
Deploy
MaintainRetire

Demo: Tesla API Team
• API Objective
–Allow mobile apps to access and control a
user’s Tesla Model S
• Team:
–API Designer: Keshav (kesh92)
–Server Developer: Server User (demoUser)
–Android App Developer
–Documentation Writer
Tesla Android App

Demo: Tesla API
• API: Basic API with the following endpoints:
–/vehicle (GET):
• Get details about vehicle
–/vehicles/{id}/data_request/drive_state (GET)
• Retrieve vehicle drive state information
–/vehicles/{id}/command/set_temps (POST):
• Set vehicle temperature targets

Demo: Tesla API
The structure of our workflow will be as follows –
API Designer
Organization
Collaborator
Transfer API ownership
Fork Compare and Merge

Resources
YouTube Channel Name: swaggerhub
Twitter Handle: @swaggerhub
Help: app.swaggerhub.com/help

Thank you

All of the Power of Swagger
In One Integrated Platform
Get started for free today!
SwaggerHub.com

The API Economy and How to Optimize Your Organization's Swagger API Workflow

Recommandé

Recommandé

Contenu connexe

Plus de SmartBear

Plus de SmartBear (20)

Dernier

Dernier (20)

The API Economy and How to Optimize Your Organization's Swagger API Workflow