Hypermedia
Hypermedia is content or information structured with links or controls that enable navigation to related resources or actions.
Building Web APIs with ASP.NET Core
Hypermedia is media content that embeds links or controls enabling navigation to related resources or actions.
- How it is used
- Uses hypermedia to make next actions discoverable in RESTful board-game API responses.
- How deep it goes
- Works through response DTOs and one generated self link, while leaving modification links as a proposed extension.
- Examples
- Shows a BoardGames controller returning three games with a generated GET self link in JSON.
- What you can do after
- Build it from scratch using C# response DTOs and an ASP.NET Core controller that returns data with descriptive links.
Read how Building Web APIs with ASP.NET Core explains hypermedia →
Microservices Patterns, Second Edition
HATEOAS is a REST constraint in which resource representations contain links that guide clients through available application actions.
- How it is used
- Uses resource representations to guide clients through actions in a Level 3 REST service.
- How deep it goes
- Defines links in GET representations and gives an example, but does not detail their implementation.
- Examples
- Uses an order representation with a link for canceling the order.
- What you can do after
- Evaluate REST APIs by identifying which maturity level they support.
Read how Microservices Patterns, Second Edition explains hypermedia →
The Design of Web APIs, Second Edition
A hypermedia format is a data representation format that embeds links, actions, or other controls describing how related resources and operations can be discovered.
- How it is used
- Enables consumers to discover related resources and possible actions at runtime instead of guessing paths or operations.
- How deep it goes
- Works through HAL links and Siren actions, but stops short of a full treatment of hypermedia formats.
- Examples
- Compares plain JSON, HAL, and Siren money transfers, including account relations and a cancellation action.
- What you can do after
- Evaluate/understand when standardized links and actions help consumers, and select browsing features without hiding essential data.
Read how The Design of Web APIs, Second Edition explains hypermedia →
Spring in Action, Sixth Edition
HATEOAS is a REST constraint in which hypermedia controls guide a client through an application's available resources and state transitions.
- How it is used
- Guides API clients through available resources and state transitions using hyperlinks.
- How deep it goes
- Explains link-based navigation, generated responses, and tradeoffs, then stops short of implementing custom hypermedia APIs.
- Examples
- Uses curl responses for ingredient collections and individual ingredients containing self, ingredient, and profile links.
- What you can do after
- Apply it via Spring Data REST by consuming generated hyperlinks as navigation targets for subsequent API requests.
Read how Spring in Action, Sixth Edition explains hypermedia →
Also covered in
What to know first
- RESTREST is an architectural style for distributed systems that organizes interactions around identifiable resources and their representations, using a uniform interface and constraints such as statelessness and cacheability.
- HTTPHTTP is an application-layer protocol that defines request-and-response communication for transferring resource representations and related metadata between networked systems.
- GraphQLGraphQL is a query language and execution specification for APIs that lets clients request and manipulate data through a schema.
- HTTP GETHTTP GET is a safe, idempotent HTTP method that requests a representation of a resource without intending to change its state.
Related concepts
- base pathproduced by · A base path is the common URL or URI path prefix under which an application, API, or set of resources is exposed.
- OpenAPI specificationcontrasts with · The OpenAPI Specification is a machine-readable standard for describing HTTP APIs, including their operations, inputs, outputs, data structures, and security requirements.
Questions about hypermedia
What is hypermedia?
Hypermedia is content or information structured with links or controls that enable navigation to related resources or actions.
Which Manning books explain hypermedia?
Building Web APIs with ASP.NET Core, Microservices Patterns, Second Edition, The Design of Web APIs, Second Edition and Spring in Action, Sixth Edition.
What should I know before learning hypermedia?
Manning books that teach hypermedia usually introduce REST, HTTP, GraphQL and HTTP GET first.
What is the difference between hypermedia and OpenAPI specification?
Hypermedia is content or information structured with links or controls that enable navigation to related resources or actions. The OpenAPI Specification is a machine-readable standard for describing HTTP APIs, including their operations, inputs, outputs, data structures, and security requirements.
What kinds of hypermedia are there?
Kinds of hypermedia include HAL, JSON:API and Siren.
These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.



