HATEOAS

HATEOAS, an abbreviation for Hypermedia as the Engine of Application State, is a constraint of the REST application architecture that distinguishes it from most other network application architectures. The principle is that a client interacts with a network application entirely through hypermedia provided dynamically by application servers. A REST client needs no prior knowledge about how to interact with any particular application or server beyond a generic understanding of hypermedia. By contrast, in a service-oriented architecture (SOA), clients and servers interact through a fixed interface shared through documentation or an interface description language (IDL).

The HATEOAS constraint decouples client and server in a way that allows the server functionality to evolve independently.

Details

A REST client enters a REST application through a simple fixed URL. All future actions the client may take are discovered within resource representations returned from the server. The media types used for these representations, and the link relations they may contain, are standardized. The client transitions through application states by selecting from the links within a representation or by manipulating the representation in other ways afforded by its media type. In this way, RESTful interaction is driven by hypermedia, rather than out-of-band information.^[1]

For example ^[2] here is a GET request to fetch an Account resource, requesting details in an XML representation:

    GET /account/12345 HTTP/1.1
    Host: somebank.org
    Accept: application/xml
    ...

Here is the response:

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: ...
 
    <?xml version="1.0"?>
    <account>
       <account_number>12345</account_number>
       <balance currency="usd">100.00</balance>
       <link rel="deposit" href="/account/12345/deposit" />
       <link rel="withdraw" href="/account/12345/withdraw" /> 
       <link rel="transfer" href="/account/12345/transfer" />
       <link rel="close" href="/account/12345/close" />
     </account>

Note the response contains 4 possible follow-up links - to make a deposit, a withdrawal, a transfer or to close the account.

Some time later the account information is retrieved again, but now the account is overdrawn:

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: ...
 
    <?xml version="1.0"?>
    <account>
        <account_number>12345</account_number>
        <balance currency="usd">-25.00</balance>
        <link rel="deposit" href="/account/12345/deposit" />
    </account>

Now only one link is available: to deposit more money. In its current state, the other links are not available. Hence the term Engine of Application State. What actions are possible vary as the state of the resource varies.

A client does not need to understand every media type and communication mechanism offered by the server. The ability to understand new media types can be acquired at run-time through "code-on-demand" provided to the client by the server.^[3]

Origins

The HATEOAS constraint is an essential part of the "uniform interface" feature of REST, as defined in Roy Fielding's doctoral dissertation.^[3] Fielding has further described the concept on his blog.^[1]

The purpose of some of the strictness of this and other REST constraints, Fielding explains, is "software design on the scale of decades: every detail is intended to promote software longevity and independent evolution. Many of the constraints are directly opposed to short-term efficiency. Unfortunately, people are fairly good at short-term design, and usually awful at long-term design".^[1]

Implementations

• Spring HATEOAS,^[4] part of the Spring Framework
• Yii 2 Framework REST API supports HATEOAS, ^[5] part of the Yii Framework (since version 2.0)
• Jersey API supports HATEOAS^[6]
• Tastypie supports HATEOAS^[7]
• Eve supports HATEOAS^[8]

See also

• Hypertext Application Language

References