
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-codeInstalls 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- Rails Dev293
- Ios Ui Refactor291
- Ruby Optimise286
- Swift Optimise285
- Ios Testing281
- Swift Refactor281
- Dev Rfc279
- Swift Ui Architect273
- Ios Taste272
- Ios Storyboard270
- Rails Design System270
- Swift Data268
- Ios Chaos Monkey267
- Ios Navigation267
- Nginx C Module Perf260
- React Native Elements258
- Effect Ts257
- Bug Review256
- Nginx C Module Debug253
- Rails Application Ui Blocks251
- Rust Write Tests248
- Rust Implement246
- Domain Architect242
- Graph Schema233