Need Real RESTfull hypermedia example

[CottonWood]

Hi,

I have been studying RESTfull and developing my first API and facing lot's of questions related to HATEOAS (hypermedia). Are there any real API which provide fully RESTfull API with hypermedia to study as an example?

[Jørn Wildt]

Well, there ain't many hypermedia driven public facing services yet. Amazon has started using HAL and it's service is documented here: http://docs.aws.amazon.com/appstream/latest/developerguide/rest-api.html

Real examples can be hard to understand since they tend to include all sorts of very domain specific stuff that hides the hypermedia details. Try instead this demo of a hypermedia driven issue tracker at mason-issue-tracker.cbrain.net. It uses Mason (https://github.com/JornWildt/Mason) as the media type.

The issue tracker demo is a scaled down version of an internal hypermedia service we are running in my company and is thus close to be a real example with both reading, searching, writing and even file uploads. You can read more about the issue tracker example here https://github.com/JornWildt/Mason/wiki/Example-service%3A-issue-tracker and here http://soabits.blogspot.dk/2014/02/representing-issue-tracker-with-mason.html

The last example is not a real service but illustrate a few hypermedia details anyway: http://soabits.blogspot.dk/2014/03/modelling-shipment-example-as.html

/Jørn

On Thu, Apr 24, 2014 at 4:23 PM, CottonWood <shamil...@gmail.com> wrote:

Hi,

I have been studying RESTfull and developing my first API and facing lot's of questions related to HATEOAS (hypermedia). Are there any real API which provide fully RESTfull API with hypermedia to study as an example?

--
You received this message because you are subscribed to the Google Groups "API Craft" group.
To unsubscribe from this group and stop receiving emails from it, send an email to api-craft+...@googlegroups.com.
Visit this group at http://groups.google.com/group/api-craft.
For more options, visit https://groups.google.com/d/optout.

[Jørn Wildt]

Sorry, the issue tracker link should have been http://mason-issue-tracker.cbrain.net/resource-common

On Thu, Apr 24, 2014 at 4:23 PM, CottonWood <shamil...@gmail.com> wrote:

Hi,

I have been studying RESTfull and developing my first API and facing lot's of questions related to HATEOAS (hypermedia). Are there any real API which provide fully RESTfull API with hypermedia to study as an example?

--

[Kin Lane]

I'm slowly building a list of leading examples in the space.

I'm updating this blog post with them as I find - http://apievangelist.com/2014/04/15/what-are-some-good-examples-of-hypermedia-apis/

I will also be adding them to my research project soon - http://hypermedia.apievangelist.com/

Thanks - Kin

[mca]

while it's not a real app, this Maze server[0] is an example of a pure read-only hypermedia type[1]. This server is written in C#. There is also a server & client written using NodeJS[2]

The example page (from 2011) includes pointers to other client apps built for it and even hosts a "bot" that runs the maze all by itself.

Cheers.

[0] http://amundsen.com/examples/misc/maze-client.html

[1] http://amundsen.com/media-types/maze/

[2] https://github.com/RESTful-Web-APIs/example-code/tree/master/Maze

mca

+1.859.757.1449
skype:mca.amundsen
http://amundsen.com/blog/
http://twitter.com/mamund
https://github.com/mamund
http://linkedin.com/in/mamund

On Thu, Apr 24, 2014 at 11:22 AM, Darrel Miller <darrel...@gmail.com> wrote:

Kin Lane has been making a list
http://apievangelist.com/2014/04/15/what-are-some-good-examples-of-hypermedia-apis/

[Paul Hill]

I just started writing up some of my best practices for building ReST APIs. It might be helpful.

Our API (https://api.kixeye.com/api/v2/docs/) is on the verge of full hypermedia, maybe maturity model level 2.5 as we don't have a huge call for accessing the schema and links yet. But I do outline a bunch of stuff that works in the field.

http://paulwilliamhill.blogspot.ca/

It's the bones of a presentation I'll be doing at QCon NYC.

https://qconnewyork.com/presentation/all-your-api-are-belong-us

:-)

On Thursday, April 24, 2014 7:23:29 AM UTC-7, CottonWood wrote:

[CottonWood]

Thank you, guys! Your links were helpful.

четверг, 24 апреля 2014 г., 19:23:29 UTC+5 пользователь CottonWood написал:

[Pedro Santos]

Just for the record Paypal also includes hypermedia controls in it's responses: https://developer.paypal.com/docs/api/#hateoas-links (@Kin Lane: maybe you can include this on your list)

Cheers,
Pedro

[Kin Lane]

Interesting...adding.

Kin Lane (API Evangelist)

kin...@gmail.com

@kinlane

--

apievangelist.com

apicommons.org

apivoice.com

--

--

[sgoto]

I have a few demos running here:

http://code.sgo.to/rows/#url=http://code.sgo.to/

--
f u cn rd ths u cn b a gd prgmr !

[Nicolas Grenié]

You can check how we built apibunny.com hypermedia API using Fortune.js framework http://www.3scale.net/2014/04/building-apibunny-using-fortune-js-jsonapi/

The whole code is on github.
Enjoy :)

[Rob Zazueta]

The new VerticalResponse API uses hyperlinks to identify related resources. Not sure whether it's also applying content negotiation at this point, but it's pretty straight forward out of the box:

http://developer.verticalresponse.com/docs/read/HATEOAS_API

On Thursday, April 24, 2014 7:23:29 AM UTC-7, CottonWood wrote:

[Diana Espino]

I found the chapter on HATEOAS in this book to be a good example: https://leanpub.com/build-apis-you-wont-hate?a=0EUlx7b61FYA6XOBNB6oOU

[Thiyagu Dakshinamurthy]

I did an in-house development of APIs in which I had done HATEOAS based Framework called Interaction Representation using Interactions, Contexts and Guided flows see below

The concept of Main context and sub-context is driven by User Experience design. The interaction representation framework above has HATEOAS in Guided flows. The main challenge I had was to make the clients HATEOAS compliant.  This framework even has code-on-demand in form of xpath and jsonpath to let client know how to construct complex transitions using guided flow.

The framework was successful and adoption among client developers was encouraging. The REST apis was not only targeted for web/mobile apps, but to other UI/UX applications like IVR in call centers.

cheers,

thiyagu

[K Bala]

There is good example on this http://restcookbook.com/Basics/hateoas/