+ Follow

Api anti patterns

by Mike Pearce on Aug 07, 2010

25,302 views

API Patterns are boring, API Anti-Patterns are not.

API Patterns are boring, API Anti-Patterns are not.

Delivered at PHPLondon on 5th Aug 10'

Accessibility

View text version

Upload Details

Uploaded via SlideShare as Apple Keynote

Usage Rights

File a copyright complaint

22 Embeds 18,947

http://blog.programmableweb.com	14669
http://www.3scale.net	1764
http://blog.mikepearce.net	1167
http://blog.lroot.com	828
http://java.dzone.com	437
http://polvocorso.wordpress.com	30
http://translate.googleusercontent.com	7
http://architects.dzone.com	7
https://www.3scale.net	7
http://3scale.semantricks.com	7
http://feeds.feedburner.com	6
http://www.printwhatyoulike.com	3
http://ishafizan.blogspot.com	2
url_unknown	2
http://www.facebook.com	2
http://meltwaternews.com	2
http://www.dzone.com	2
http://wwwdev.3scale.net	1
http://www.slideshare.net	1
https://ungoodthinkful.appspot.com	1
http://localhost	1
http://www.linkedin.com	1

More...

Statistics

Likes: 32
Downloads: 228
Comments: 5
Embed Views: 18,947
Views on SlideShare: 6,355
Total Views: 25,302

Api anti patterns Presentation Transcript

API Anti Patterns or, how to not f**k up your API

or, tips on how to annoy your API consumers

or, think you know REST? Awesome!

or, some of the crazy s**t people do with REST

Hello

Mike Pearce

http://social-network.com /MikePearce

http://social-network.com /MikeyPearce

http://social-network.com /mikepearce.net

http://social-network.com /MikePearce

An Apology

RE HE h ISP ort S ON ebw @ Kn Flags shoul d be banne d a festival s!

Bu rritos: l. Food . Ever. Best. Festiva

Mike, Lee and Rog

SORRY

( HTTP REQUEST: ) That you get on with it...

a mIh ere? Why REST

a mIh ere? Why REST Ha h!

a mIh ere? Why ST REST Hu h?!

Do’s ✔

Do’s ✔ Dont’s ✘

Do’s ✔ Dont’s ✘ Whatevs.. ☠

Some But fi rst... background

Who? Roy Fielding (the grandfather)

There!

Architectural Styles and the Design of Network- Can’t s ead tbased leep? his... Software R Architectures

A A nd now ... quick primer

REST != HTTP

REST != HTTP REST != The Web

REST

REST IS NOT

REST IS NOT HA

REST IS NOT Se HA riou sly!

Standards? We don’t need no steenkin’ standards!

MY CONSTRAINTS, LET ME SHOW YOU THEM

e ve rbs... Som

e nou ns... Som

GET

PINT

PINT Plea se!

main event Ont o the ANTI patterns

Overuse of ...

GET

Overuse of GET and POST or, GET/POST tunnelling.

GET: BA http://api.ﬂickr.com/services/ rest/?method= ﬂickr.photos.people.add &api_key=nnn&photo_id=yyy&u ser_id=xxx

PUT: /user/MikePearce api_key=moo& age=33& size=medium& power=ﬂight GOOD

PUT or POST? PUT: /users/MikePearce PUT: /links/google PUT: /articles/100805/putorpost ASIDE

PUT or POST? POST: /documents/save name=styleguide.css& category=design ASIDE

PUT or POST? PUT when the resource will live at the target URI POST when you want the server to handle the location of the resource. ASIDE

POST: /dostuff/ user=MikePearce& BA action=delete& api_key=moo& token=quack& mode=3

DELETE: /user/MikePearce Wait! W hat? Wh y!? GOOD

Tunneling Errors through

Are you OK? I’m ﬁne! Great! A 200 OK!

Are you OK? I’m ﬁne! Great! A 200 OK! ARGGHH! He doesn’t understand me!

This is better...

GET: /droid/r2d2 GET: /droid/c3po 404: Not the droids you’re looking for

HTTP/1.1 200 OK Content-Type: text/plain <?xml version="1.0" encoding="UTF-8" ?> <response code="error"> <error>Error!</error> <text>You have errored.</text> ed t o do </response> I su ppos What am this? with

Which leads me nicely to... RESPONSE CODES

IE has failed Informational

FTW!1 Success

Redirection

illust rating (yo u try ent er ror!) cli Client Error

n’t fi nd an s 1am . I ca error. It’ erver i mage for s Server Error

PUT: /user/MikePearce HTTP/1.1 200 OK Meh..

PUT: /user/MikePearce HTTP/1.1 201 CREATED Huzzah!

GET: /whatareyou HTTP/1.1 418

GET: /whatareyou HTTP/1.1 418 I’m a teapot is real1!! This one

Caching

E-Tags

HTTP/1.1 304 NOT MODIFIED HTTP/1.1 200 OK Date: Mon, 23 May 2005 22:38:34 GMT Last-Modified: Wed, 08 Jan 2003 23:11:55 Etag: "3f80f-1b6-3e1cb03b" Connection: close Content-Type: text/html; charset=UTF-8

Mmm ... Delicious!

HYPERMEDIA

HYPERMEDIA What is it?

HYPERMEDIA AS THE ENGINE OF APPLICATION STATE

oar...

HATEOAS (Remember hating oars)

Grey Areas

V3r510n1ng Versioning

GET: /user/MikePearce in. Prolific Him aga bas tard.

GET: /user/MikePearce GET: /user/66

1. Versioning with the URI GET: /v1/user/MikePearce GET: /v2/user/66

2. Not versioning the primary URI GET: /user/66 GET: /v1/user/MikePearce

3. No versioning GET: /user/66

Document Extensions

Either

Either GET: /reports/tpsreport/summary.json GET: /reports/tpsreport/summary.xml

Either GET: /reports/tpsreport/summary.json GET: /reports/tpsreport/summary.xml or

Either GET: /reports/tpsreport/summary.json GET: /reports/tpsreport/summary.xml or Accept: text/xml Accept: application/json

SUM Phew! MARY

Overuse of GET and POST or, GET/POST tunnelling.

Tunneling Errors through

Which leads me nicely to... RESPONSE CODES

E-Tags

HATEOAS (Remember hating oars)

V3r510n1ng Versioning

Either GET: /reports/tpsreport/summary.json GET: /reports/tpsreport/summary.xml or Accept: text/xml Accept: application/json

Any qu estions? swer!) (that I can an

Photo Credits Wordle.net flickr.com/photos/wouterkiel/3717057757/ - Wouter Kiel flickr.com/photos/joe_13/19946186/ - joe_13 flickr.com/photos/23846880@N00/391925649/ - Rutger de Moddertukker flickr.com/photos/mararie/264942105/ - mararie flickr.com/photos/ndanger/7841795/ - ndanger flickr.com/photos/yourdon/2573762303/ - Ed Yourdon flickr.com/photos/thunderchild5/225675773/ - Thunderchild7 flickr.com/photos/duchamp/126115989/ - Duchamp flickr.com/photos/thefangmonster/490423135/ - The fang monster flickr.com/photos/nostri-imago/2894328425/ - cliff1066 flickr.com/photos/epsos/4582789354/ - epSos.de flickr.com/photos/projector/2092517108/ - allie pasquier flickr.com/photos/nickstone333/3135320160/ - nickstone333 flickr.com/photos/rdrcollection/116454033/ - Rodney Ramsey flickr.com/photos/christophercarfi/2730304130/ - Christophercarfi flickr.com/photos/turatti/4526352835/ - jaci xIII

Thanks! Mike Pearce mike@mikepearce.net mikepearce.net twtitter.com/mikepearce

Shyam Habarakada, Development at Artefact Full talk, which is needed for these slides is at http://vimeo.com/13922981 3 months ago

Are you sure you want to

Giljae Joo, Customer Project & Architect & Consultant at HP Korea Best slide. 7 months ago

Sam Ramji, Software Strategist at Apigee Best. 418 I'm a teapot. Slide. Ever.

But where is the 420 'Chill out' error slide? 2 years ago

Tobin Harris, Director at Pocketworks Mobile Best 404 slide. Ever :) 2 years ago

Jay Cuthrell, Consultant at cuthrell.com Best. 200 OK. Slide. Ever. 2 years ago