How to use hypermedia to read data
REST Resources
Hypertext Linking within an Entity |
3.3 Representations
3.3.3 A resource identifier labeled "url" MUST be present in all RESTful API resource representations |
| Hypermedia / HATEOAS |
Collection GET endpoints
should link to relations next and prev for pagination purposes |
Public-friendly APIs
While it is still recommended to include hypermedia links to encourage good practices, is it not mandated like for internal services. |
| Expanding Resources Through Hypermedia Linking |
| Hypermedia and REST |
| Relationships and Sub-Resources |
| Hypermedia Links (Pagination) |
| Options and link headers |
Big collections
the serialization payload MUST contain the opaque URL for the next page |
| Paging Hypermedia Links |
Create New Resource
Hypermedia links provide an easy way to get the URL of the newly created resource |