Swagger for Startups

Tony Tam@fehguy

Why Swagger?

The API Development Process is

Broken!

API Consumers get short end of stick

Build a technology

Slap on an API

Make clients suffer“Our API exposes back end

resources”“Server doesn’t

care how Client

calls it”

Then what’s right?

•Describe the API interface!

• Methods

• Params, allowable values, ranges

• Models

•Set expectations!

•Build from the interface

You have to

commit to your service!

Javadocs?

A Description-driven API Approach

•Describe the API

• How?

Developer Docs?

WADLWADL2

?

WSDL?

You need an API

description format!

Model, Iterate (then Code)

No code! Just JSON

The Benefit of a Description

Client-Side Developer

OMG I can code w/o

waiting for back end!

The client developer

isn’t bugging me!

API Developer

But…

SHOW ME

Demo

•See demo here:• http://github.com/fehguy/swagger-demo/README.md

More Info• Wordnik Developer:

• http://developer.wordnik.com

• http://tech.wordnik.com

• Swagger:

• http://swagger.wordnik.com

• http://github.com/wordnik/swagger-codegen

• Scalatra:

• http://scalatra.org

• All of the above:

• http://www.wordnik.com/jobs

Questions?