rails-api-design

What problem does it solve?

AI coding agents frequently generate Rails APIs that skip critical production conventions, leading to technical debt, security gaps, and maintenance headaches from missing versioning, poor serialization choices, lack of rate limiting, and inconsistent error formatting.

Core Features & Use Cases

• URL API Versioning: Implements /api/v{n} versioning for debuggable, cacheable routes, avoiding the operational pitfalls of Accept-header versioning.
• Production Serialization: Recommends and configures jsonapi-serializer for JSON:API specs or alba for plain JSON, replacing slow, error-prone to_json calls.
• Security & Reliability Defaults: Includes pre-built patterns for JWT/session cookie authentication, rack-attack rate limiting, structured error responses per RFC 9457 or JSON:API, secure CORS configuration, and rswag OpenAPI documentation.
• Use Case: Use this Skill when building a new Rails::API app, adding JSON endpoints to an existing Rails monolith, or auditing an existing API for compliance with senior Rails developer best practices.

Quick Start

Use the rails-api-design skill to build a versioned, production-ready JSON API for your Rails app with proper serialization, pagination, and rate limiting configured out of the box.