Basic REST Concepts

Transcript

1. REST
2. ToC Resources Actions/Verbs Security
3. Go Watch ! Hypermedia APIs by Jon Moore http:// vimeo.com/20781278 ! Building Restful APIs, and how learning the word hypermedia will make you look smarter - Sebastien Lambla http://vimeo.com/37936696
4. Resources ! Anything that is important enough to be referenced as a thing in itself.
5. Resources - Examples ! A movie ! A bank account ! A purchase order ! A time entry
6. Resources ! Must have a unique address. ! HTTP URIs (Uniform Resource Identifier)
7. URI ! In a RESTful web service a URI is a hyperlink to a resource.
8. URI ! The only means to exchange representations of resources. ! /user?id=29123 ! /employee/007/vacations
9. URI ! Used to link resources together {name: “Jon Doe”, rel: [ {self: ‘http://a.domain.com/user/4123’}, {address: ‘http://a.domain.com/address9823’} ]}
10. Representations ! What is sent back between clients and servers
11. Representations ! Different clients can consume different representations of the same resource. ! Resource must be available through the same URL.
12. URL ! Defines the network location of a specific resource
13. URL ! http://a.domain.com/user?id=12345
14. URL ! Format Representation determined by Content- Type application/json application/text application/xml
15. URL : Content-Type ! http://www.w3.org/Protocols/rfc2616/rfc2616- sec14.html#sec14.17
16. HTTP Actions/Verbs ! GET ! PUT ! DELETE ! POST ! PATCH
17. GET ! http://www.w3.org/Protocols/rfc2616/rfc2616- sec9.html#sec9.3 ! For Retrieving resources ! Can not have side effects ! Can act as both read & query operations
18. POST ! Creates a new resource ! http://www.w3.org/Protocols/rfc2616/rfc2616- sec9.html#sec9.5
19. POST : Status ! 201 - Created ! 200 (OK) ! 204 (No Content) ! 202 (Accepted - processing not completed)
20. PUT ! Update or Create ! http://www.w3.org/Protocols/rfc2616/rfc2616- sec9.html#sec9.6
21. PUT : Status ! 201 - Created ! 200 - OK ! 204 (No Content)
22. DELETE ! Delete resource ! http://www.w3.org/Protocols/rfc2616/rfc2616- sec9.html#sec9.7
23. DELETE : Status ! 200 (OK - Response Includes entity) ! 202 (Accepted - Will process later) ! 204 (No Content - No entity)
24. PATCH ! Partial Updates
25. HTTP Status Codes ! 1xx informational messages ! 2xx success messages ! 3xx redirects client to another URL ! 4xx client-side error ! 5xx server-side error ! http://www.w3.org/Protocols/rfc2616/rfc2616- sec10.html
26. Security ! Basic Auth (username/password) ! OAuth (auth provider, user consent) ! API Keys