Rest API

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

By Rohana K Amarakoon
1
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

Invented World Wide Web, HTML, Web Browser
Tim Berners-Lee
New Version Hypertext Transfer Protocol, (HTTP/1.1)
Formalize U...

In year 2000 Roy Fielding named and described the Web’s architectural style
“Representational State Transfer” (REST).
REST...

4
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

Having a REST API
web service “RESTful”
consists of an assembly of interlinked resources.
Set of resources is known as the...

http://api.example.restapi.org/france/paris/louvre/leonardo-da-vinci/mona-lisa
Uniform Resource Identifiers (URI)
URI Form...

(/) separator indicate a hierarchical relationship
Hyphens (-) used to improve the readability URI
http://api.example.rest...

Underscores (_) should not be used in URIs
http://api.example_restapi.org/blogs/mark-masse/entries/this-is-my-first-post
h...

File extensions should not be included in URIs
http://api.college.restapi.org/students/3248234/transcripts/2005/fall
http:...

Consistent sub domain names for client developer Portal
The top-level domain and then sub domain names.
http://developer.s...

( /) separated path segment corresponding to unique resource
http://api.soccer.restapi.org
http://api.soccer.restapi.org/l...

Document (Base Archetype)
Resource archetypes helps consistently communicate the structures and
behaviors.
http://api.socc...

Store
PUT /users/1234/favorites/Alonso
client-managed resource repository
Controller
Controller names typically appear as ...

A singular noun for document names
http://api.soccer.restapi.org/leagues/seattle/teams/trebuchet/players/clau
dio
WRML dia...

A plural noun for store names
http://api.music.restapi.org/artists/mikemassedotcom/playlists
A verb or verb phrase for con...

Define a query
URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]
Query is an unique identification of a...

Query component used to filter collections or stores
GET /users
GET /users?role=admin
Query component used to paginate col...

Request methods
Request-Line = Method SP Request-URI SP HTTP-Version CRLF
Response codes
100 200 300 400
Message headers
R...

Request methods
Request-Line = Method SP Request-URI SP HTTP-Version CRLF
GET /greeting HTTP/1.1
GET and POST must not be ...

HEAD used to retrieve response headers
Date: Sat, 20 Aug 2011 16:02:40 GMT
PUT used to insert and update a stored / mutabl...

DELETE used to remove a resource from its parent
DELETE /accounts/4ef2d5d0-cb7e-11e0-9572-800200c9a66/buckets/objects/4321...

Term Description
DELETE HTTP request method (RM) - remove its parent.
GET HTTP RM - retrieve a representation of a resourc...

23
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

Term Description
Request-Line RFC 2616 defines its syntax as :
Method SP Request-URI SP HTTP-Version CRLF
Request method I...

Status-Line = HTTP-Version SP Status-Code SP Reason-Phrase CRLF
Response Status Codes Categories
Category Description
1xx:...

Response Status Codes In Detail
Code Name Meaning
200 OK Indicates a nonspecific success
201 Created Sent primarily by col...

Code Name Meaning
301 Moved New permanent URI has been assigned to the
client’s requested resource
303 See Other Sent by c...

Code Name Meaning
400 Bad Request Indicates a nonspecific client error
401 Unauthorized Sent when the client either provid...

Code Name Meaning
406 Not Acceptable Sent when the client tried to request data
in an unsupported media type format
409 Co...

Various forms of metadata conveyed through the entity headers
HTTP’s request
HTTP’s response messages.
REST API HTTP’s sta...

Stores support conditional PUT requests
(insert and update)
client#1 PUT client#2
creates 200 Created
overwrite 409 Confli...

Cache-Control, Expires, and Date used to encourage caching
Date: Tue, 15 Nov 1994 08:12:31 GMT
Expires: Thu, 01 Dec 1994 1...

Media Type Syntax
type "/" subtype *( ";" parameter )
type
application audio image message
model multipart text video
para...

Registered Media Types
Governed by Internet Assigned Numbers Authority† (IANA)
text/plain
no specific content structure or...

application/atom+xml
Content is XML-based format that structures data into lists known
as feeds.
application/javascript
So...

Message Body Format
Commonly used XML and JSON formats
XML < > tag pairs.
JSON { } hierarchically structure.
XML – (EXtens...

XML
XML is a markup language much like HTML
XML was designed to carry data, not to display data
XML tags are not predefine...

JSON
{
"firstName" : "Osvaldo",
"lastName" : "Alonso",
"firstNamePronunciation" : "ahs-VAHL-doe",
"number" : 6,
"birthDate...

39
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

consistent form should be used to represent links
WRML media type
application/wrml;
format=“http://api.formats.wrml.org/ap...

consistent form should be used to represent relations
WRML media type
application/wrml;
format=“http://api.formats.wrml.or...

Links should be used to advertise a resource’s available actions in a
state-sensitive manner
{
# Fields...
"links" : {
“se...

A consistent form used to represent media type formats
# Request
GET /application/json HTTP/1.1
Host: api.formats.wrml.org...

Document Schema Representation
# Request…
# Response…
{
"name" : "Document",
"version" : 1,
"stateFacts" : ["Docroot", "Id...

REST APIs are designed to suit the needs of their client programs
Why Versioning ????
REST API is a resource model (compos...

Schemas used to manage representational form versions
REST API’s resource representations managed by versioned schema
docu...

Security
OAuth used to protect resources (Open Authorization / “open standard )
Web site #01 Share info Web site #2
Userna...

OAuth Applications
48
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

49
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

50
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

51
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

52
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

53
Copyright to Rohana K Amarakoon @ http://uncopyrightables2011.blogspot.com/

The query component of a URI should be used to support partial
responses
Save on bandwidth & accelerate the overall intera...

JavaScript facilitates applications that are instantly available
everywhere.
JS programs provide the interactive parts of ...

following resources has a different origin.
http://restapi.org
https://restapi.org
http://www.restapi.org
http://restapi.o...

JSONP supported to provide multi-origin read access from JavaScript
57
Copyright to Rohana K Amarakoon @ http://uncopyrigh...

CORS provide multi-origin read/write access from JavaScript
58
Copyright to Rohana K Amarakoon @ http://uncopyrightables20...

REST API development frameworks originally created to help build
web applications
Developers don’t want to code web page t...

Current REST API development frameworks lack direct support for:
Uniform, cross-format hypermedia structures
Media type sc...

For more information
E-mail :
Rohana.blogs@gmail.com
Blog :
http://uncopyrightables2011.blogspot.com/
Twitter :
@MaxRohana...

Share Slideshare

LinkedIn
Facebook
Twitter

Embed

Size (px)

Show related Slideshows at end

WordPress Shortcode

Link

Share
Email

Windows Azure Essentials by Rohana K Amarakoon 980 views
Security in IT (data and cyber secu... by Rohana K Amarakoon 1335 views
Introduction to windows azure by Rohana K Amarakoon 1532 views
Policies & Laws in IT industry by Rohana K Amarakoon 3040 views
New Product Management AIB (MBA) ... by Rohana K Amarakoon 3594 views
Professional bodies in IT by Rohana K Amarakoon 15593 views

View on Slideshare

1 of 61 Ad

View on Slideshare

1 of 61 Ad