Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.76 KB

readme.md

File metadata and controls

47 lines (33 loc) · 2.76 KB
Raw

Hypermedia API Example

alt tab

Based on Mike Amundsen book Building Hypermedia APIs with HTML5 and Node, source code of the book

To learn more about REST and Hypermedia-API please check the following resources

Project Structure

At the moment EWF does not use convention over configuration, so every project will have his own structure, here is the breakdown for the app example

  • hypermedia_cj
    • src -- Source code cluster.
      • root -- root application able to launch the app with either cgi, libfcgi, or nino connector.
        • any -- launch the app with either cgi, libfcgi, or nino connector.
        • default -- launch the application using nino connection.
      • handler -- Handlers to manage specific uris defined in HYPERMEDIA_REST_SERVER.
      • utils -- Utils classes.
      • converter -- Utils classes to convert an Eiffel object to JSON.
      • HYPERMEDIA_REST_SERVER
    • www -- document root containing html pages, js and css files needed by the application
    • api_hyper-safe.ecf -- Eiffel configuration file

Application Architecture

Before to see our custom implemtation for our example, it's recomended to see the basic application architecture and the common lifecyle that every ewf application will have. So first read the wiki page [application lifecycle] (https://github.com/EiffelWebFramework/ewf_examples/wiki/Application-Lifecycle)

State Transitions

The following diagram shows the possible states that we represent in our Hypermedia API.

![alt tab](./img/State transitions.png)

Every state in this diagram corresponds to a particular page, that a user can browse, so the current page you are visiting, represents the Application State. So every transition fom one Application State to another corresponds to links you decided to follow or forms you fill out. In some cases not all transitions are available from all states.

Application state is kept on the client, but the server can manipulate it by sending representations in this case Collection+JSON, (an Hypermedia media type) that describe the possible state transitions. Resource state is kept on the server, but the client can manipulate it by sending the server a representation.