Given at API Craft NYC, http://www.meetup.com/API-Craft-NYC/events/209294892/

1. Designing a Hypermedia
API with {Grape} & Roar
Daniel Doubrovkine
@dblockdotorg

3. sale JSON

4. 1K+ cache.delete

6. GET /api/v1/me/follows
{
_type:*
}

7. GET /api/v1/…
5 years later …

8. https://developers.artsy.net

9. Adopt a standard …

10. JSON+HAL
JSONAPI
Collection+JSON
SIREN
JSON-LD

11. 1:1 URI:RESOURCE
path?query=string

13. API Root
Discoverable API

14. Document

15. Collections
typed

16. Implement it!
https://github.com/dblock/grape-with-roar
https://github.com/dblock/grape-with-roar-walkthrough

17. Map 1:1 with Database Fields vs. Relations

18. Use Version Headers and Media Types
curl 'http://api.artsy.net/api' -H 'Accept:application/vnd.artsy-v2+json'

19. Make it Flat

20. Paginate with Offsets, not Pages

21. Present Everything, Including Errors

22. Thanks!
@dblockdotorg / dblock@dblock.org / artsy.net