VOOZH about

URL: https://apistylebook.com/design/topics/hypermedia-read

⇱ Hypermedia (read)


Hypermedia (read)

How to use hypermedia to read data

Atlassian - Atlassian REST API Design Guidelines version 1

REST Resources
Hypertext Linking within an Entity

Australian Digital Transformation Office - API Design Guide

Management state with HATEOAS

Cisco - API Design Guide

3.3 Representations
3.3.3 A resource identifier labeled "url" MUST be present in all RESTful API resource representations

Cloud Foundry - Cloud Controller API v3 Style Guide (Proposal)

Resources
Links

Deliveroo - API Design

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.

Haufe - Haufe API style guide

Expanding Resources Through Hypermedia Linking
Hypermedia and REST
Relationships and Sub-Resources
Hypermedia Links (Pagination)

Microsoft - Microsoft REST API Guidelines

Options and link headers
Big collections
the serialization payload MUST contain the opaque URL for the next page

PayPal - API Style Guide

Paging Hypermedia Links
Create New Resource
Hypermedia links provide an easy way to get the URL of the newly created resource

Red Hat - Thoughts on RESTful API Design

REST Metadata
Link Headers
Relationships

Zalando - RESTFul API Guidelines

Use Pagination Links Where Applicable
Use a well-defined subset of HAL
Use Custom Link Relations
Do Not Use Link Headers with JSON entities