Download to read offline
![REST Constraints
1. Uniform Interfaces – Resource Model
• Every resource has a unique id which uniquely identify.
• Every resource has URI [Uniform Resource Identifier].
URI Syntax URI](https://image.slidesharecdn.com/restfulservicessession2-restfundamentals-170210170850/85/Restful-Fundamentals-69-320.jpg)
![REST Constraints
1. Uniform Interfaces – Resource Model
• Every resource has a unique id which uniquely identify.
• Every resource has URI [Uniform Resource Identifier].
URI Syntax URI](https://image.slidesharecdn.com/restfulservicessession2-restfundamentals-170210170850/85/Restful-Fundamentals-77-320.jpg)
![CONNECTEDNESS
{
"employees": [ "/employees/alice",
"/employees/bob",
"/employees/eve",
...
]
"next_page": "/employees?start=10",
"create_employee": "/employees"
}](https://image.slidesharecdn.com/restfulservicessession2-restfundamentals-170210170850/85/Restful-Fundamentals-131-320.jpg)
Uploaded bySuresh Madhra
Restful Fundamentals
The document provides a comprehensive overview of REST (Representational State Transfer) and its principles, emphasizing the architecture of HTTP and resource-oriented design. Key components discussed include HTTP methods (GET, POST, PUT, DELETE), status codes, URIs, and the concept of resources as addressable entities on the web. It also covers REST constraints such as statelessness, cacheability, and the separation of client and server responsibilities.
More Related Content
Similar to Restful Fundamentals
![[2015/2016] The REST architectural style](https://cdn.slidesharecdn.com/ss_thumbnails/06crest-160429194845-thumbnail.jpg?width=640&height=640&fit=bounds)
Restful Fundamentals
- 1. REST Fundamentals – ApplyingHTTP Methods
- 2.
- 3. REST HTTP + Resource-OrientedArchitecture
- 4. AGENDA - HTTP HTTP RESOURCE STATIC DYNAMIC URL RESOURCE LOCATOR RESOUCRE IDENTIFER VERBS GET POST PUT DELETE CONTENTTYPE MESSAGE HTTP REQUEST HTTP RESPONSE STATUS CODE 1xx - INFORMATIONAL 2xx - SUCCESSFUL 3xx - REDIRECTION 4xx – CLIENT ERROR 5xx – SERVER ERROR WWW HTML
- 5. WHAT IS THEWEB? An information system of interlinked hypertext documents and resources accessed via the Internet
- 6.
- 7.
- 8. AGENDA - HTTP HTTP RESOURCE STATIC DYNAMIC URL RESOURCE LOCATOR RESOUCRE IDENTIFER VERBS GET POST PUT DELETE CONTENTTYPE MESSAGE HTTP REQUEST HTTP RESPONSE STATUS CODE 1xx - INFORMATIONAL 2xx - SUCCESSFUL 3xx - REDIRECTION 4xx – CLIENT ERROR 5xx – SERVER ERROR WWW HTML
- 9. RESOURCES Anything that canbe identified, named, addressed or handled on the Web
- 10. RESOURCE ▫ Can beconcrete things: • Web Pages • Video files • Articles • Blogs • Image file
- 11. RESOURCE ▫ Can bestatic and dynamic
- 12. RESOURCE ▫ Can alsorepresent abstract concepts • Employee or Product or Order • Time • Money Transfer • Calendar • User Accounts
- 13. AGENDA HTTP HTTP RESOURCE STATIC DYNAMIC URL RESOURCE LOCATOR RESOUCRE IDENTIFER VERBS GET POST PUT DELETE CONTENT TYPEMESSAGE HTTP REQUEST HTTP RESPONSE STATUS CODE 1xx - INFORMATIONAL 2xx - SUCCESSFUL 3xx - REDIRECTION 4xx – CLIENT ERROR 5xx – SERVER ERROR WWW HTML
- 14. URL Uniform Resource Locator A URL is a specialization of URI that defines the network location of resource URL defines how the resource can be obtained eg. http://some.domain.com/orderinfo?id=123
- 15. URL ANOTOMY UR I- Uniform Resource I d e n t i f i e r UR L - Uniform Resource L o c a t o r
- 16. RESOURCE IDENTFIERS A resourceonly exists on the Webif it has an identifier (URI)
- 17. RESOURCE NAMES ▫ URN- Uniform Resource Name • products/54321 • about-us • articles/web.html • posts/2015-01-12 • podcasts/rest.mp3 • products/9595
- 18. AGENDA HTTP RESOURCE STATIC DYNAMIC URL RESOURCE LOCATOR RESOUCRE IDENTIFER CONTENT TYPE VERBS GET POST PUT DELETE MESSAGE HTTPREQUEST HTTP RESPONSE STATUS CODE 1xx - INFORMATIONAL 2xx - SUCCESSFUL 3xx - REDIRECTION 4xx – CLIENT ERROR 5xx – SERVER ERROR WWW HTML
- 19. HTTP cantransfer any kind of information between clients and servers E.g. Text files, PDF, e-documents, images, videos, etc. In any case, the data is streamed over TCP/IP and browser knows how to interpret the binary streams because of the HTTP protocol response header Content-Type CONTENT-TYPES
- 20. AGENDA HTTP RESOURCE STATIC DYNAMIC URL RESOURCE LOCATOR RESOUCRE IDENTIFER CONTENT TYPE VERBS GET POST PUT DELETE MESSAGE HTTPREQUEST HTTP RESPONSE STATUS CODE 1xx - INFORMATIONAL 2xx - SUCCESSFUL 3xx - REDIRECTION 4xx – CLIENT ERROR 5xx – SERVER ERROR WWW HTML
- 21.
- 22. AGENDA HTTP RESOURCE STATIC DYNAMIC URL RESOURCE LOCATOR RESOUCRE IDENTIFER CONTENT TYPE VERBS GET POST PUT DELETE MESSAGE HTTP REQUEST HTTP RESPONSE STATUSCODE 1xx - INFORMATION 2xx - SUCCESSFUL 3xx - REDIRECTION 4xx – CLIENT ERROR 5xx – SERVER ERROR WWW HTML
- 23. HTTP STATUS CODE Ser ver ’s processed status corresponding to a request Combination of numerical code & short description
- 24. AGENDA HTTP RESOURCE STATIC DYNAMIC URL RESOURCE LOCATOR RESOUCRE IDENTIFER CONTENT TYPE VERBS GET POST PUT DELETE MESSAGE HTTPREQUEST HTTP RESPONSE STATUS CODE 1xx - INFORMATIONAL 2xx - SUCCESSFUL 3xx - REDIRECTION 4xx – CLIENT ERROR 5xx – SERVER ERROR WWW HTML
- 25.
- 26.
- 27. HTTP MESSAGE -REQUEST Server Client Yahoo.comMozilla Firefox HTTP Request GET /HTTP/1.1 User-Agent: Mozilla Firefox Host: example.com Accept: */*
- 28. HYPERTEXT TRANSFER PROTOCOL ServerClient Yahoo.comMozillaFirefox HTTP Response HTTP/1.1 200 OK Content-Type: text/html Content-Length: 1270 <!doctype html> <html> <head> <title>Example Domain</title> </head> <body> … </body> </html>
- 29. HTTP request messageis sent from the client (Brower) to HTTP Web-Server. Request message contain: location of a resource or resource URI HTTP method to use when accessing the resource. Optional request headers (name-value pairs) providing additional information Request body that identifies additional data to be uploaded to the server (e.g. form parameters, attachments, etc.) HTTP REQUEST MESSAGE
- 30. HTTP response messageis sent from HTTP Web-Server back to the client (Web-Browser). Response message contain: Carry status of processed request. Provide response headers (name-value pairs) providing additional information about the response Supplies optional response body that identifies additional data to be downloaded to the server (e.g. html, images, attachments etc. HTTP RESPONSE MESSAGE
- 31.
- 32.
- 33. /fruits/list?category=fruits&limits= 20 Path to resource Query string HTTP/1.1 HTTP HEADER – REQUEST LINE
- 34. Request/ Response GeneralHeader Carry information about the HTTP transaction Can be a part of request, as well as response General Headers HTTP HEADER – GENERAL
- 35. Request Header Specificto an HTTP Request Carry information about the client, and the type of request Facilitates better understanding between client and server Request Headers HTTP HEADER – REQUEST
- 36. Request/ Response EntityHeader Carry information about the content Mainly part of HTTP Response Entity Headers HTTP HEADER – ENTITY
- 37. HTTP REQUEST RESPONSEMESSAGE EXCHANGE
- 38.
- 39. REST HTTP + Resource-OrientedArchitecture
- 40. REST HTTP + Resource-OrientedArchitecture RESTful
- 41. What is REST? REST is not a technology, nor a framework REST is an architectural style - Set of principles & constraints Why constraints? Constraints help us in developing applications that are “easy” to maintain and extend. REST
- 42.
- 43.
- 44.
- 45. In general,a RESTful resource is anything that is addressable over Web Addressable = anything that can be accessed and transferred between clients and servers Resource must have a unique address over the Web Under HTTP these are URIs RESOURCES
- 46. In a RESTfulweb service, Resources are categorized as: Singleton resource is a single chunk of information, similar to a row in a database table. Collection resource is a set of resources with the same structure, similar to a selection of rows in a database table. RESOURCES MODEL
- 47. Uniform Resource Identifier In a RESTful web service, It is a hyperlink to a resource Means for clients and servers to exchange representations of resources ex. .../orderinfo?id=123 Only means to locate a specific resource Used to negotiate representations of a given resource In the url you give certain parameters that define which information you want the server to return to you (just like giving GET variables to a page). Server will respond you with a resource representation containing the information you’ve asked URIs
- 48. URIs are alsoused to link resources together. ex. URIs
- 49.
- 50. Representation of resourcesis what is sent back and forth between clients & servers So, we never send or receive resources, only their representations REPRESENTATION
- 51. Format ofthe representation is determined by the content- type Interaction of the representation on the resource is determined by the action (GET, POST etc.) REPRESENTATION
- 52. Different clientsare able to consume different representations of the same resource A representation can take various forms, such as: • image • a text file • an XML stream • a JSON stream Note: But its resource has to be available through the same URI REPRESENTATION FORMATS
- 53. REPRESENTATION FORMATS For human-generatedrequests through a web browser, a representation is typically in the form of an HTML page For automated requests from other web services, readability is not as important and a more efficient representation can be used such as XML or JSON
- 54.
- 55. ACTIONS Actions are usedto operate on resources For example, they can be used for – getting info about a movie – adding a photo to Flickr – deleting a file from a folder Note: Data transmitted to and from the resource is a representation of it.
- 56. HTTP-BASED ACTIONS Note:RESTful web services can also execute logic at the server level, but remembering that every result must be a resource representation
- 57. HTTP as UninformInterface Note: RESTful web services can also execute logic at the server level, but remembering that every result must be a resource representation
- 58. HTTP as UninformInterface Restful Approach Traditional Approach Focus on resource names Focused on the actions to be performed on resources Four specific actions that we can take upon resources — Create, Retrieve, Update, and Delete (CRUD) Countless actions with no naming or implementation standards
- 59. HTTP as UninformInterface
- 60. Artificial example ofa web service handling students in some classroom Location of the service = http://restfuljava.com/ Resources are represented as XML streams CLASSROOM EXAMPLE
- 61. Student (identified byname): http://restfuljava.com/students/{name} List of students: http://restfuljava.com/students CLASSROOM EXAMPLE - URIs
- 62.
- 63.
- 64. CLASSROOM EXAMPLE -REPRESENTATIONS GET POST PUT DELETE GET is used to RETRIEVE resources POST is used to CREATE resources PUT is used to UPDATE resources DELETE is used to DELETE resources No side effects Has side effects Has side effects Has side effects Can also return only parts of the resource The resource identity/URL is not known at creation time Return updated resource URL Used for Read operation and query
- 65.
- 66.
- 67.
- 68.
- 69. REST Constraints 1. UniformInterfaces – Resource Model • Every resource has a unique id which uniquely identify. • Every resource has URI [Uniform Resource Identifier]. URI Syntax URI
- 70. Resource URL Mappingwith HTTP Method HTTP Methods Resource CRUD OperationsResource URI
- 71.
- 72.
- 73. REST Constraints 1. UniformInterfaces
- 74. REST Constraints 1. UniformInterfaces - Resources
- 75. REST Constraints 1. UniformInterfaces - Resource • Resource is a chunk of related information of an entity. • Can be static and dynamic. • Resources words are ‘NOUNS’ such as Movies, Employees, Products, Photos
- 76. REST Constraints 1. UniformInterfaces – Resource Model • Singleton resource is a single chunk of information, similar to a row in a database table. • Collection resource is a set of resources with the same structure, similar to a selection of rows in a database table.
- 77. REST Constraints 1. UniformInterfaces – Resource Model • Every resource has a unique id which uniquely identify. • Every resource has URI [Uniform Resource Identifier]. URI Syntax URI
- 78. REST Constraints 1. UniformInterfaces – Resource Model Yahoo Social REST APIs Singleton resource : Following URI defines the profile resource for the user whose ID is 12345. https://social.yahooapis.com/v1/user/12345/profile The next URI specifies the connections (friends) for the user whose ID is 6677. https://social.yahooapis.com/v1/user/6677/connections Collection resource : Following URI accesses the collection of schools contained in the profile of the user of ID 98765. https://social.yahooapis.com/v1/user/98765/profile/schools
- 79. REST Constraints 1. UniformInterfaces - Methods
- 80. Resource URL Mappingwith HTTP Method HTTP Methods Resource CRUD OperationsResource URI REST Constraints
- 81.
- 82. REST Constraints 1. UniformInterfaces - Representations
- 83.
- 84. 2. Stateless Server Twotypes of State Application State Resource State REST Constraints
- 85. 2. Stateless Server No client context is stored on the server between requests. Each request from any client contains all of the information necessary to service the request, and any state is held in the client. The server can be stateful, this constraint merely requires that server-side state be addressable by URL as a resource. REST Constraints
- 86. REST Constraints Application State Exchangeof Request Identify between Server and Client
- 87. REST Constraints Resource State Whatis stored on the server (Beyond Session)
- 88. REST Constraints 2. StatelessServer Each request contains ALL the information necessary to understand it Application (session) state is kept on the client
- 89. REST Constraints 2. StatelessServer Visibility - Performance Reliability - Consistency Scalability
- 90.
- 91. 1. Client -Server Separation of Concerns: Client responsible for UI Server responsible for data storage REST Constraints
- 92. 1. Client -Server REST Constraints + Scalability + Simplicity
- 93.
- 94. REST Constraints 3. Cache Clients are able to cache responses. Responses must, implicitly or explicitly, define themselves as cacheable or not.
- 95. REST Constraints 3. Cache Efficiency Scalability UP Performance
- 96.
- 97.
- 98. READING A TEXTRESOURCE http://example.com/hello-world.txt GET /hello-world.txt HTTP/1.1 Host: example.com HTTP Request
- 99. READING A TEXTRESOURCE http://example.com/hello-world.txt HTTP Response HTTP/1.1 200 OK Content-Type: text/plain Content-Length: 13 Hello, World!
- 100. CREATING A TEXTRESOURCE POST / HTTP/1.1 Host: example.com Content-type: text/plan Hello Mars HTTP Request
- 101. CREATING A TEXTRESOURCE HTTP/1.1 201 Created Location: /hello-mars.txt HTTP Response
- 102. RESOURCE DOES NOTEXIST http://example.com/hello-world.txt GET /hello-world.txt HTTP/1.1 Host: example.com HTTP Request
- 103. RESOURCE DOES NOTEXIST HTTP/1.1 404 Not Found HTTP Response
- 104. EMPLOYEE RESOURCE Name Gender Role
- 105.
- 106. JSON REPRESENTATION { "name": "Alice", "role":"Developer", "gender": "female" }
- 107.
- 108.
- 109.
- 110. LIST EMPLOYEE RESOURCES GET/employees HTTP/1.1 Host: example.com Accept: application/xml HTTP Request
- 111. LIST EMPLOYEE RESOURCES HTTPResponse HTTP/1.1 200 OK Content-Type: application/xml <employees> <employee href="/employees/alice"/> <employee href="/employees/bob"/> <employee href="/employees/eve"/> </employee>
- 112. LIST EMPLOYEE RESOURCES HTTPResponse HTTP/1.1 200 OK Content-Type: application/xml <employees> <employee href="/employees/alice"/> <employee href="/employees/bob"/> <employee href="/employees/eve"/> </employee>
- 113. READ EMPLOYEE RESOURCE GET/employees/alice HTTP/1.1 Host: example.com Accept: application/xml HTTP Request
- 114. READ EMPLOYEE RESOURCE HTTPResponse HTTP/1.1 200 OK Content-Type: application/xml <employees> <name>Alice</name> <role>Developer</role> <gender>Female</gender> </employee>
- 115. CREATE EMPLOYEE RESOURCE HTTPRequest POST /employees HTTP/1.1 Host: example.com Content-Type: application/xml <employee> <name>John</name> <role>QA</role> <gender>male</gender> </employee>
- 116. CREATE EMPLOYEE RESOURCE HTTPResponse HTTP/1.1 200 OK
- 117. UPDATE EMPLOYEE RESOURCE HTTPRequest PUT /employees/alice HTTP/1.1 Host: example.com Content-Type: application/xml <employee> <name>Alice</name> <role>Manager</role> <gender>female</gender> </employee>
- 118. UPDATE EMPLOYEE RESOURCE HTTPResponse HTTP/1.1 201 Created Location: /employees/john
- 119. DELETE EMPLOYEE RESOURCE HTTPRequest DELETE /employees/alice HTTP/1.1 Host: example.com Content-Type: application/xml
- 120. DELETE EMPLOYEE RESOURCE HTTPResponse HTTP/1.1 204 NO Content
- 121. RESOURCE ORIENTED ARCHITECTURE Addressability Statelessness Connectedness Uniform Interface
- 122. ADDRESSSABILITY Every interesting pieceof information the server can provide should be exposed as a resource, and given its own URI http://example.com/employees/alice
- 123. STATELESSNESS Every HTTP requestshould happen in complete isolation http://google.com/search?q=jellyfish
- 124.
- 125.
- 126. STATELESSNESS Application State vs.Resource State
- 127. CONNECTEDNESS Documents should containnot just data, but links to other resources
- 128.
- 129.
- 130.
- 131. CONNECTEDNESS { "employees": [ "/employees/alice", "/employees/bob", "/employees/eve", ... ] "next_page":"/employees?start=10", "create_employee": "/employees" }
- 132. HATEOS Hypermedia As TheEngine of Application State
- 133.