Swagger introduction - the - whys

Giovanni and Jus,n on Swagger and RAML

Mike from FlockData on microservices experience

Pizza

Get out of here
Auckland API and Microservices Meetup
I
3rd mee,ng

IBM team
Recep,onist
Security
Fire warden

Janitor
Safety brieﬁng

•  list of everyone
•  at the end all of the guests have to leave
•  health and safety and emergency
•  bathrooms and the emergency exits
•  leave the mee,ng room in a ,dy state
•  alcohol must be managed responsibly

Introduc)on to
SWAGGER
(the whys)
Giovanni Vigorelli
IBM middleware

How one presents him or her self to the world.
Swagger is shown from how the person
handles a situa,on. It can also be shown in the
person's walk.
hMp://www.urbandic,onary.com/deﬁne.php?term=swagger
Can we start without a deﬁni,on?
A person's style- they way they walk, talk, dress.
I'm loving his swagger!

It’s all about making themselves visible
REST Web API is like browsing a web
site with your eyes closed!
In the ‘old days’ or in ‘the other room’ there’s WSDL
(SOAP web services), complex and ugly as you like,
but up for the job

Which problems it tries (successfully) to solve
API discovery
API readability
Development speed up
- client and server side decoupling
- crea,ng REST API from your code
- generate code from API
Remove barriers
between Business
(product owners) and IT
(developers)

Swagger.json
API discovery (deﬁni,on)
swagger
info
host
basePath
schemes
consumes
produces
paths
deﬁni,ons
(… or YAML)

Swagger UI helps to deﬁne a standard for REST API documenta,on.

No more documenta,on cowboys !
API readability (documenta,on)

API defini,on allows client side
developers to create client against
swagger defini,on (codgen or test)
API defini,on allows server side
developers implement the logic to server
API resources
Dev. speed up – client and server decoupling
Business Services Mobile, Web,
whatever Apps

S
w
a
g
g
e
r .
j
s
o
n

Dev speed up – code genera,on
Swagger Tools
Swagger JS
Swagger Codegen

Dev. speed up – API genera,on
JAX-RS

Remove Business – Development barriers
Top Down BoMom up
Iden,fy
commercial
products
Design the API
Implement the
API logic
Leverage IT legacy
Leverage IT legacy
Externalize IT
assets
Marke,ng a
product

100% open source, loved by big players

Swagger api RAML api Blueprint api
3 players…
… 1 winner!
(if it was a race)

hMp://www.miramax.com/subscript/pulp-ﬁc,on-celebra,ng-20-years/
Images credit:
hMps://en.wikipedia.org/wiki/Night_vision_device
hMp://swagger.io
hMps://maxpreme.wordpress.com/2008/12/08/the-north-face-x-swagger/
hMps://www.google.co.nz/trends/
hMp://www.telestar.fr/2014/photos/zach-galiﬁanakis-l-incroyable-perte-de-poids-de-l-
acteur-de-very-bad-trip-diaporama-49531
hMp://mic.com/ar,cles/77505/why-everyone-is-so-mad-about-the-wolf-of-wall-
street#.GL46BT50a

Swagger introduction - the - whys

More Related Content

Viewers also liked (12)

Recently uploaded (20)

Swagger introduction - the - whys