the api economy and how to optimize your organization's swagger api workflow
TRANSCRIPT
Get started for free: swaggerhub.com
The API Economy and How to Optimize Your Organization's
Swagger API Workflow
Get started for free: swaggerhub.com
Presented by…
Product Marketing Manager, SwaggerHubKeshav 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.
Get started for free: swaggerhub.com
Agenda
•Understanding the API economy•Business opportunities presented by APIs •Deciding on the right approach to API development
•Optimizing the API workflow with SwaggerHub
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
Number of connected devices
No. of devices/personIn 2020
7 devices
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
Great success stories – API Provider
https://www.programmableweb.com/apis/directory
Get started for free: swaggerhub.com
Great success stories – API Consumer- Seamless integrations with tons of appshttps://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
Get started for free: swaggerhub.com
How Swagger framework fits in to your API strategy
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
Understanding them better
Design First(option 1)
Code First(option 2)Business
opportunityStrategic document
Contract Code the API
Contract/Document
ation
Code the API
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
The API Workflow
Design
Develop
Deploy
Retire
Plan
The API Lifecycle
Get started for free: swaggerhub.com
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 / configurationsPrototyping
30+ languages
Collaborative, Integrated
Get started for free: swaggerhub.com
The proposed API workflow
Plan Design
Develop
Document
Deploy
MaintainRetire
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
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
Get started for free: swaggerhub.com
Demo: Tesla APIThe structure of our workflow will be as follows –
API Designer
Organization
Collaborator
Transfer API ownership
Fork Compare and Merge
Get started for free: swaggerhub.com
Resources
YouTube Channel Name: swaggerhub
Twitter Handle: @swaggerhub
Help: app.swaggerhub.com/help
Get started for free: swaggerhub.com
All of the Power of SwaggerIn One Integrated Platform
Get started for free today!SwaggerHub.com