How do I install the API Hateoas Hypermedia skill?

Run npx skillmds@latest add deangrant/api-hateoas-hypermedia in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is API Hateoas Hypermedia safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with API Hateoas Hypermedia?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is API Hateoas Hypermedia free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published API Hateoas Hypermedia?

deangrant (@deangrant) published this skill. Their other Agent Skills are listed on their SkillMD profile.

API Hateoas Hypermedia by deangrant

Name: API Hateoas Hypermedia
Author: deangrant

API Hateoas Hypermedia

Design pragmatic HATEOAS for REST APIs using HAL or JSON:API links, including self/next and state-transition actions. Use when adding hypermedia, reviewing RMM Level 3, or deciding against full HATEOAS.

deangrant 1d06e41 4 files · 2.6 KB Updated Sep 17, 2026

File contents

HATEOAS and Hypermedia APIs

Use this skill when clients should follow links instead of hard-coding URL templates (RMM Level 3). Full adoption is rare — prefer a pragmatic subset.

1. Idea

Server returns currently valid actions as links (e.g. drop cancel when shipped). Clients discover next steps from the representation.

2. Formats

Format	Media type	Shape
HAL	`application/hal+json`	`_links`, `_embedded`
JSON:API	`application/vnd.api+json`	`links`, relationships

Use IANA rels (self, next, prev) or URI-namespaced custom rels. Include method hints for non-GET actions.

3. Pragmatic subset

Always self
Pagination next/prev (body links or Link header)
Key state-transition links only

OpenAPI Link Object is design-time docs, not runtime HATEOAS. Media-type versioning pairs better with hypermedia than path versioning.

4. Quick checklist

Full vs pragmatic vs Level 2-only decision documented.
One hypermedia format if used.
State-dependent links; methods on non-GET.
self + pagination links minimum.
Documented for clients/SDKs.

See reference.md and examples.md.

Frequently asked questions