Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

REST API design with HATEOAS (Rails) v1.0.0

Use this resource to design or review a hypermedia REST API in Rails

New

  • 394 downloads
  • 158 likes
  • 211 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install restful-api-hateoas-design

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent applies 47 rules ordered by the request-response cycle: resource URIs, method semantics, link relations, status codes, content negotiation and HTTP caching. You get an API that clients can navigate through its links.

Mostly picked by

Updated November 2, 2026

Card for the “REST API design with HATEOAS (Rails)” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • AGENTS.md: rules by category, from resources to caching
  • references/coll-cursor-pagination.md: cursor pagination; references/cache-etag-conditional-get.md: ETags and conditional requests

Good fit for

  • Your Rails API returns hard-coded URLs that clients copy
  • You want consistent pagination and filters across every collection

Not for

    Tags

    • rest
    • hateoas
    • rails
    • api

    About

    You say

    “Review our Rails API controllers and add the missing hypermedia links.”

    Card for the “REST API design with HATEOAS (Rails)” skill

    Skill published by pproenca under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to design or review a hypermedia REST API in Rails
    3. Review and adjust the result

    Content preview

    Files

    • AGENTS.md0.2 KB
    • assets/templates/_template.md0.8 KB
    • LICENSE1.1 KB
    • metadata.json1.2 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/_sections.md2.5 KB
    • references/cache-cache-control-headers.md3 KB
    • references/cache-etag-conditional-get.md2.6 KB
    • references/cache-last-modified.md2.7 KB
    • references/cache-vary-header.md3.1 KB
    • references/coll-cursor-pagination.md3.6 KB
    • references/coll-field-selection.md4.2 KB
    • references/coll-filtering-via-query-params.md3.4 KB
    • references/coll-link-header-pagination.md3.1 KB
    • references/coll-sorting-convention.md3 KB
    • references/err-auth-error-codes.md3.8 KB
    • references/err-error-links.md2.9 KB
    • references/err-machine-readable-codes.md2.6 KB
    • references/err-problem-details.md2.6 KB
    • references/err-validation-errors.md2.7 KB
    • references/evolve-additive-changes-only.md2.6 KB
    • references/evolve-deprecation-headers.md3.1 KB
    • references/evolve-hateoas-reduces-versioning.md3.3 KB
    • references/http-delete-is-idempotent.md2.4 KB
    • references/http-get-must-be-safe.md2.3 KB
    • references/http-head-for-metadata.md2.7 KB
    • references/http-idempotency-key.md3.9 KB
    • references/http-patch-for-partial-updates.md3.1 KB
    • references/http-post-for-creation.md2.5 KB
    • references/http-put-for-full-replacement.md2.7 KB
    • references/link-action-affordances.md2.8 KB
    • references/link-embedded-vs-linked.md3.9 KB
    • references/link-entry-point.md2.4 KB
    • references/link-pagination-links.md2.6 KB
    • references/link-related-resource-links.md2.3 KB
    • references/link-self-link-every-resource.md2.2 KB
    • references/link-standard-relation-types.md2.6 KB
    • references/media-406-for-unsupported-types.md3 KB
    • references/media-accept-header-negotiation.md2.5 KB
    • references/media-content-type-in-responses.md2.6 KB
    • references/media-vendor-media-types.md3 KB
    • references/res-limit-nesting-depth.md2 KB
    • references/res-model-business-entities.md2.2 KB
    • references/res-noun-based-uris.md1.7 KB
    • references/res-plural-collection-uris.md1.8 KB
    • references/res-sub-resources-for-relationships.md2.7 KB
    • references/res-use-consistent-identifiers.md2.3 KB
    • references/status-201-with-location.md2.8 KB
    • references/status-202-for-async.md3.8 KB
    • references/status-204-for-no-content.md2.8 KB
    • references/status-409-for-conflicts.md3 KB
    • references/status-allow-header-on-405.md3.7 KB
    • references/status-rate-limit-headers.md3.8 KB
    • SKILL.md8.2 KB

    Origin and licence

    Listed unmodified

    Author
    pproenca
    Source
    github.com/pproenca/dot-skills/tree/cf93c57cac89d6fc3e4194686000411567f5caf3/skills/.curated/restful-hateoas
    Licence
    MIT

    Notice

    « restful-hateoas » (pproenca, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.