How (not) to write an API
Jakub Nešetřil
Wednesday, September 26, 12

apiary.io
Wednesday, September 26, 12

API?
apiary.io
source: http://www.flickr.com/photos/21496790@N06/5065834411
Wednesday, September 26, 12

API?
apiary.io
source: http://www.flickr.com/photos/daddo83/3406962115/
Wednesday, September 26, 12

API?
apiary.io
source: http://www.flickr.com/photos/ecstaticist/3570660643/
Wednesday, September 26, 12

RPC
apiary.io
source: http://www.flickr.com/photos/jasleen_kaur/5075553223
Wednesday, September 26, 12

<?xml version="1.0"?>
<methodCall>
<methodName>examples.getUser</methodName>
<params>
<param>
<value><i4>102</i4></value>
</param>
</params>
</methodCall>
<?xml version="1.0"?>
<methodResponse>
<params>
<param>
<value><string>John Doe</string></value>
</param>
</params>
</methodResponse>
apiary.io
Wednesday, September 26, 12

SOAP
apiary.io
source: http://www.flickr.com/photos/jasleen_kaur/5075553223
Wednesday, September 26, 12

POST /InStock HTTP/1.1
Host: www.example.org
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 299
SOAPAction: "http://www.w3.org/2003/05/soap-envelope"
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Header>
</soap:Header>
<soap:Body>
<m:GetUser xmlns:m="http://www.example.org/user">
<m:Name>John Doe</m:Name>
</m:GetUser>
</soap:Body>
</soap:Envelope>
apiary.io
Wednesday, September 26, 12

REST
apiary.io
source: http://www.flickr.com/photos/tambako/6992962266/
Wednesday, September 26, 12

GET /users/?name=John%20Doe HTTP/1.1
Content-Type: application/json; charset=utf-8
200 OK
[{
name: {
first: "John",
last: "Doe"
}
}]
apiary.io
Wednesday, September 26, 12

POPULAR
apiary.io
source: http://www.flickr.com/photos/keithallison/6327068376
Wednesday, September 26, 12

NO PROTOCOL
apiary.io
source: http://www.flickr.com/photos/24298372@N04/3370859327/
Wednesday, September 26, 12

ORTHODOX BELIEVERS
apiary.io
source: http://www.flickr.com/photos/45818813@N05/4785640636/
Wednesday, September 26, 12

PURITY WARS
apiary.io
source: http://www.flickr.com/photos/davidkingham/3661515844/
Wednesday, September 26, 12

HOW TO WRITE AN API?
apiary.io
source: http://www.flickr.com/photos/21496790@N06/5065834411
Wednesday, September 26, 12

EVERY API IS DIFFERENT
apiary.io
source: http://www.flickr.com/photos/marinacast/2255974192/
Wednesday, September 26, 12

Latency?
apiary.io
Wednesday, September 26, 12

Mobile?
Latency?
apiary.io
Wednesday, September 26, 12

s? Mobile?
ox ie
Pr
Latency?
apiary.io
Wednesday, September 26, 12

s? Mobile?
ox ie
Pr Caching
?
Latency?
apiary.io
Wednesday, September 26, 12

s? Mobile?
ox ie
Pr Caching
?
Latency?
Interactive?
apiary.io
Wednesday, September 26, 12

s? Mobile?
ox ie
Pr Caching
?
Latency?
Interactive?
Data size?
apiary.io
Wednesday, September 26, 12

apiary.io
source: http://www.flickr.com/photos/freeflyer09/7460144118
Wednesday, September 26, 12

EXPERIMENT
apiary.io
source: http://www.flickr.com/photos/samipii/7590121284/
Wednesday, September 26, 12

apiary.io
source: http://www.flickr.com/photos/samipii/7590121284/
Wednesday, September 26, 12

RESULTS
apiary.io
source: http://www.flickr.com/photos/eisenbahner/3697448759/
Wednesday, September 26, 12

Mock > Use > Implement
apiary.io
Wednesday, September 26, 12

Mock > Use > Implement
apiary.io
Wednesday, September 26, 12

apiary.io
Wednesday, September 26, 12

Mock > Use > Implement
apiary.io
Wednesday, September 26, 12

Documentation
Automated Testing
Mock > Use > Implement
apiary.io
Wednesday, September 26, 12

source: http://www.flickr.com/photos/lorenia/3464878271/
Wednesday, September 26, 12

Q&A
E-MAIL jakub@apiary.io TWITTER @apiaryio
Wednesday, September 26, 12