The OpenAPI Specification (formerly known as the Swagger Specification) has emerged as the world’s standard for defining RESTful interfaces at a time when the API economy is ripe for disruption. In this webinar, we discussed exactly why and how to use the OpenAPI Specification to accelerate your API development in various phases of the API lifecycle including API design, development, documentation, testing and virtualization.
We cover trends in the API landscape that have led to the adoption of API definitions, like OpenAPI, and look at real-world examples of how API teams are using definitions to address challenges at each of the different phases of the lifecycle of their APIs. And finally, we walk through a live demo showing tools like Swagger Inspector for generating API definitions, SwaggerHub for designing, documenting, and developing your APIs, and SoapUI and ServiceV for testing and virtualizing your API.
5. Page
Visitswaggerhub.comtogetstartedfor free.
5
Twitter: @keshinpoint
APIs Have Been Around For A LONG Time
Service Oriented
Architecture
Objectives –
• Services designed with data in mind
• Modelled canonically
• Using data origin (cryptic) vocabulary
• Loose if any documentation
Modern Web APIs
8. Page
Visitswaggerhub.comtogetstartedfor free.
8
Twitter: @keshinpoint
Trend2:API First Approach
Backend Developers
Frontend Developers
Client A
Database
Implementation Implementation Implementation
Mock Mock Mock
API API API
Client B Client C
The API First approach involves having your APIs as the first and primary element of your
product and service strategy.
11. Page
Visitswaggerhub.comtogetstartedfor free.
11
Twitter: @keshinpoint
The Modern API
• The ModernAPI is no longer datadriven, but consumer driven
• The ModernAPI is staged for self service development and consumption
• The ModernAPI is built for speed of updating and maintenance
• The ModernAPI has a common vocabularly
Reusable interfacesbased on HTTP standards that allow for reuse of data and functions, built for consumer
demand and self-service
15. Page
Visitswaggerhub.comtogetstartedfor free.
15
Twitter: @keshinpoint
Advantages Of Definition Driven Development
Reduced interdependencies, allows teamsto workattheir own pace
Faster development and delivery
Easier expansion to different interfaces,clients and views
Developer friendly servicesto build ecosystems and platforms
Faster Development
New Revenue Channels
and Growth
29. Page
Visitswaggerhub.comtogetstartedfor free.
What is ServiceVirtualization
Virtualization accuratelymimics/simulates behavior of components thatare unavailable or difficult to access
during software development and beyond.
Examples of Components that canbe Virtualized:
Devices Database API Network
Twitter: @keshinpoint
29
31. Page
Visitswaggerhub.comtogetstartedfor free.
31
Twitter: @keshinpoint
Advantages ofVirtualization From The Definition
Reduce dependency betweenteams(backend and front
end; database etc)
Enables paralleldevelopment
Faster prototyping
Service Virtualization
Overcome rate limits & reduce
3rd party risk
Test your service when a
virtualized API misbehaves
Use descriptors, discovery, or
manually design your sandbox
Why ServiceV Pro from SmartBear?
Create virtual services fast, locally and on the
cloud
Virtualize APIs, databases with minimal
configuration
37. Page
Visitswaggerhub.comtogetstartedfor free.
37
Twitter: @keshinpoint
Advantages of Testing From The Definition
Reduce time to marketby generating quick tests
Easily tie backto development process and refactorchanges
Mitigate risk Why ReadyAPI from SmartBear?
Easy to get started with minimum training
and skills
Over 10 Million developers and testers love
the ease of use
Powerful support for REST, SOAP, JMS and
other protocols
ReadyAPI
testing
40. Page
Visitswaggerhub.comtogetstartedfor free.
Swagger Inspector
Swagger Inspector is an easy to use online tool to quickly execute any API request, validate its
responses and generate a corresponding OpenAPI definition.
CloudBasedand
Free
OpenAPIDefinition
GenerationTestandValidate
Core Value: Ensure APIs work as intended, visually explore APIs, and create
user-friendly documentation.
Twitter: @keshinpoint
40
43. Page
Visitswaggerhub.comtogetstartedfor free.
43
What Is SwaggerHub?
Faster,Standardized
Design
SwaggerHub is the API design and documentation
platform built for teams to drive consistency and
discipline across their API development workflow.
Confusion Free Collaboration Centralized API Catalog
44. Demo Scenario
• Company: Darth Corporation
• Context:
• Dart Co. has been around for 100 years
• They have a mixture of legacy Star Wars APIs and modernized APIs
• Moving forward, they want to leverage a design first approach
• Objectives:
• Generate the definition from an existing legacy API for the deathstar
• Create a new API that retrieves information from employee database
• API Stakeholders:
• Business:
• BusinessDev & BA
• Technical:
• Architects,Developers,Tech Writers, QA, & Operations
Twitter: @keshinpoint