Download as PDF, PPTX
Uploaded bySmartLogic
Intro to Hypermedia APIs
This document introduces hypermedia APIs and REST. It discusses how hypermedia APIs rely heavily on HTTP methods and URIs, are stateless, support caching, and have a uniform interface. It provides examples of common HTTP verbs like GET, POST, PUT, DELETE and their uses. It also discusses media types, representational state transfer, and HATEOAS (Hypermedia as the Engine of Application State), which is the idea that the client should not have to know how to build routes and should instead follow links provided in responses. The document recommends using Rails, ActiveModel::Serializer, RspecApiDocumentation and other gems to build a hypermedia API, and provides an example workflow of generating models, controllers and serializers to support
More Related Content
Similar to Intro to Hypermedia APIs
Intro to Hypermedia APIs
- 1. Introduction to Hypermedia APIs Eric Oestrich @ericoestrich oestri.ch smartlogicsolutions.com
- 2. What is aHypermedia API?
- 3.
- 4. Relies Heavily onHTTP ● Methods and URI ● Media Types ● Client Server
- 5. Relies Heavily onHTTP (Cont) ● Stateless ● Caching ● Uniform Interface (HATEOAS)
- 6.
- 7. Five Routes GET /orders POST /orders GET /orders/:id PUT /orders/:id DELETE /orders/:id
- 8. GET /orders List of orders
- 9. POST /orders Createan order
- 10. GET /orders/:id Viewa single order
- 11. PUT /orders/:id Replace orcreate an order
- 12. DELETE /orders/:id Delete an order
- 13. A bit aboutHTTP Verbs
- 14.
- 15.
- 16. PUT Replace or Create Not partial
- 17.
- 18. PATCH Update partially Mustbe a diff
- 19.
- 20.
- 21. Setting the MediaType ● Accept Headers ● Rails way - .:format
- 22. Representational based Models != Representations
- 23.
- 24. Uniform Interface ● Identificationof resources ● Manipulation of resources via representations ● Self descriptive messages ● Hypermedia as the engine of application state
- 25. Identification of resources
- 26. Manipulation of resources via representations
- 27. Self descriptive messages Statelessness
- 28. Hypermedia as theengine of application state HATEOAS
- 29. Clients should notknow how to build routes
- 30. Enter HAL JSON cannotdescribe a link
- 31. HAL is amedia type for defining links in JSON application/hal+json
- 32. The Goal GET /
- 33. Great, now Iknow what a Hypermedia API is.
- 34. How do Imake one?
- 35. Rails + Lotsof Gems Also monkey patching
- 36. Gems ● ActiveModel::Serializer ● RspecApiDocumentation ● Raddocs ● A few other handy ones
- 37. $ rails newhypermedia_api --skip-test-unit
- 38. $ vim Gemfile gem'raddocs' gem 'active_model_serializers'
- 39. $ vim Gemfile group:test, :development do gem 'rspec-rails' gem 'rspec_api_documentation' end
- 40.
- 41.
- 42. Generate models, index action, serializers
- 43.
- 44.
- 45.
- 46.
- 47. Setup HAL Let themonkey patching begin
- 48.
- 49.
- 50.
- 51. Questions? Eric Oestrich @ericoestrich oestri.ch smartlogicsolutions.com