Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Documenting
Hypermedia APIs
Luke Stokes @lukestokes FoxyCart.com
HAPI adoption
“It’s not REST if it’s not HATEOS.”
“Show me the hypermedia.”
…
But we teach developers to code to URLs
(Swa...
Tells developers to code to URLs
Tools can promote link relationships! (HAL Browser)
Documentation to help us think in relationships...
Coding to link relations
https://api.foxycart.com
more coders thinking in hypermedia = more
HAPI coders
more HAPI coders b...
api.foxycart.com
Upcoming SlideShare
Loading in …5
×

RESTfest 2013 5 in 5: Hypermedia API Documentation. We're doing it wrong.

1,249 views

Published on

In this five minute presentation, I argue the tools we use (Swagger, I/O Docs, APIary) are teaching developers to code to URLs which will limit HAPI adoption.

Video available here: http://vimeo.com/75256658

Published in: Technology
  • Be the first to comment

  • Be the first to like this

RESTfest 2013 5 in 5: Hypermedia API Documentation. We're doing it wrong.

  1. 1. Documenting Hypermedia APIs Luke Stokes @lukestokes FoxyCart.com
  2. 2. HAPI adoption “It’s not REST if it’s not HATEOS.” “Show me the hypermedia.” … But we teach developers to code to URLs (Swagger, I/O Docs, APIary, etc)
  3. 3. Tells developers to code to URLs
  4. 4. Tools can promote link relationships! (HAL Browser)
  5. 5. Documentation to help us think in relationships...
  6. 6. Coding to link relations https://api.foxycart.com more coders thinking in hypermedia = more HAPI coders more HAPI coders building for hypermedia = more hypermedia tools and clients
  7. 7. api.foxycart.com

×