Skip to content
This repository was archived by the owner on Nov 6, 2025. It is now read-only.

Documenting Hypermedia API

Serge edited this page Jul 29, 2014 · 8 revisions

Main concern : most of the documentation are done via describing URI templates and actions (i.e. Swagger, API Blueprint).

But the essence of Hypermedia, are relations between resources, but not URIs.

But how to avoid URLs? As client need to know where to try to knock to. But in real Hypermedia - URI doesn't matter, you need to know only the root endpoint, and than you will discover , browsing through relations from one resource to another.

One of the solution worked (Jorn) is to document the relations in a plain text (word/html) and tell to clients that those relations are exists somewhere in ecosystem. which effectively turns to be list of resources with properties.

rel - should it be context dependent? (like 'add-user' vs. 'add' for the user resource).

Clone this wiki locally