pproenca avatar

Restful Hateoas

This is a comprehensive reference for building Richardson Level 3 REST APIs in Rails, covering everything from resource modeling and HTTP semantics to hypermedia controls and API evolution. It includes 47 rules organized by request/response lifecycle, so you can look up proper link relations, caching headers, or pagination patterns when designing endpoints. The rules are prioritized by impact, which helps when you're under time pressure and need to know what actually matters versus what's nice to have. If you're tired of ad-hoc REST decisions or arguing with your team about whether to use PUT or PATCH, this gives you concrete patterns backed by IETF specs and IANA registries. The focus on hypermedia and content negotiation makes it most useful for mature APIs where evolvability matters.

skills.sh installs
298
GitHub stars
222
last updated
Aug 21, 2026

Install

$ npx -y skills add pproenca/dot-skills --skill restful-hateoas --agent claude-code

Installs into .claude/skills of the current project.

Files

Community RESTful HATEOAS Best Practices

Comprehensive guide to building REST APIs that reach the Glory of REST (Richardson Maturity Level 3) in Ruby on Rails. Contains 47 rules across 9 categories, ordered by the request/response lifecycle — from resource URI design through hypermedia link relations to API evolution.

When to Apply

Reference these guidelines when:

  • Designing new REST API endpoints and resource URIs
  • Adding hypermedia controls (_links, affordances) to API responses
  • Implementing content negotiation with HAL, JSON:API, or vendor media types
  • Building paginated, filterable, sortable collection endpoints
  • Reviewing APIs for proper HTTP method semantics and status codes
  • Evolving APIs without breaking existing clients

Rule Categories by Priority

Sponsors

Details

Repository
github.com/pproenca/dot-skills
Categories
Backend & APIs, Code Review & Quality, Debugging, Design & UI/UX
First seen
Jun 3, 2026

More from pproenca/dot-skills

All 100
1jup-ag avatarjupiter-swap-migrationjup-ag/agent-skillsMigration guide from Jupiter Metis (v1) or Ultra to Swap API v2. Use when migrating existing Jupiter swap integrations, updating base URLs, or transitioning fro297skills.sh installs
2nodeops-app avatarcreateos-deploynodeops-app/skillsDeploy projects to CreateOS infrastructure via the MPP Gateway. Use when the user wants to deploy code, ship an app, or deploy to CreateOS. No auth session or O297skills.sh installs
310k-digital avatarlovable10k-digital/lovable-claude-codeIntegration skill for Lovable.dev projects. Activates when working with: - Lovable.dev projects with GitHub sync - Supabase Edge Functions that need deployment 296skills.sh installs
4secondsky avatarneon-vercel-postgressecondsky/claude-skillsNeon + Vercel serverless Postgres for edge and serverless environments. Use for Cloudflare Workers, Vercel Edge, Next.js apps with HTTP/WebSocket connections, d294skills.sh installs
5pedronauck avatarapp-renderer-systemspedronauck/skillsGuides creation and modification of domain feature systems organized under a systems/ directory. Covers directory layout, API service layer patterns, TanStack Q293skills.sh installs
6pproenca avatarrails-devpproenca/dot-skillsRuby on Rails performance and maintainability optimization guidelines for building backend APIs and frontend web applications. This skill should be used when wr293skills.sh installs