silkapp / rest

Packages for defining APIs, running them, generating client code and documentation.
http://silkapp.github.io/rest
390 stars 52 forks source link

Is it possible to follow HATEOAS? #159

Closed pierre-thierry closed 1 year ago

pierre-thierry commented 1 year ago

I don't see in the tutorial a way to represent an actual REST API, using HATEOAS, is it documented elsewhere?

hesselink commented 1 year ago

What kind of things are you looking for, exactly?

pierre-thierry commented 1 year ago

The guiding principle of REST is that URIs are not known and built by the client, but gathered throught hypermedia links, and you follow those links to change state. That's REpresentational State Transfer.

But in the tutorial, I only see the non-REST way of defining a client, through known URI.

I'd like a way to describe how links for state transfers are gathered in the representation of a resource.

hesselink commented 1 year ago

No, that currently doesn't exist. It should be possible to add it though, since the API definitions allow introspection.

pierre-thierry commented 1 year ago

Why call the library "rest" if it cannot describe REST APIs?