Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What does it mean that REST should be hypertext driven?

Tags:

rest

I am new to RESTful APIs and everywhere I read that REST APIs "must be hypertext-driven". I have googled a lot but haven't found a concrete explanation of the concept. So:

In practical terms, what does it mean that REST APIs should be 'hypertext-driven'?.

like image 541
Alejandro Veintimilla Avatar asked Oct 16 '14 00:10

Alejandro Veintimilla


People also ask

What does REST mean in HTTP?

Overview. A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. REST stands for representational state transfer and was created by computer scientist Roy Fielding.

Is HTTP necessary for REST?

REST is not necessarily tied to HTTP. RESTful web services are just web services that follow a RESTful architecture. HTTP is a contract, a communication protocol and REST is a concept, an architectural style which may use HTTP, FTP or other communication protocols but is widely used with HTTP.

What does HATEOAS stand for?

Hypermedia as the Engine of Application State (HATEOAS) is a constraint of the REST application architecture that distinguishes it from other network application architectures.


1 Answers

When I say hypertext, I mean the simultaneous presentation of information and controls such that the information becomes the affordance through which the user (or automaton) obtains choices and selects action. Roy T. Fielding - http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven

It is about one of the fundamental constraints of REST architectural style - Hypermedia As The Engine Of Application State (HATEOAS). It means that in any given moment, client, based on hypermedia in representation of current resource, must have all the information he needs to decide where to transit next(change its Application State). That hypermedia controls in hypertext connect resources to each other, and describe their capabilities in machine-readable ways. A REST client just needs to know one thing in order to communicate with REST server - understanding of hypermedia. Opposite, in a service-oriented architecture(SOA), clients and servers interact through a fixed interface shared through documentation or an interface description language (IDL).

HATEOAS decouples client and server so that they can be developed separately.

For example,

If you make an initial call to a rest service to add a customer using some URL /customers/ then you will get a response back (consider the customer is successfully added),

HTTP/1.1 201 Created
Location: http://www.myREST/customers/<uuid>/

Now the client who made the call to add customer knows how to find the corresponding customer from the link returned as a response header.

You may ask how does client know that he can make POST to /customer/. By different means - hypermedia controls, DSL specific formats and profiles.

like image 173
nikita Avatar answered Oct 11 '22 15:10

nikita