Rails API Golden Path Template

The recommended way to build Rails APIs at our organization.

What's Included

Category	Features
Core	Rails 8.0/7.2, Ruby 3.3/3.2, API-only mode, Puma
Observability	OpenTelemetry + Grafana, structured logging, health checks
Database	Aurora PostgreSQL, Aurora MySQL
Cache	ElastiCache Redis
Jobs	Sidekiq, Solid Queue
Auth	Devise + JWT, Doorkeeper (OAuth2)
Serializers	Alba, Blueprinter, JSON:API
Quality	RuboCop, Brakeman, RSpec

Quick Start

1. Go to Backstage Software Catalog
2. Select "Rails API (Golden Path)"
3. Fill in the form
4. Click "Create"
5. Clone and start building

What You'll Get

your-api/
├── app/
│   ├── controllers/api/v1/  # Versioned API controllers
│   ├── models/              # ActiveRecord models
│   ├── serializers/         # JSON serializers
│   ├── services/            # Business logic
│   └── jobs/                # Background jobs
├── config/                  # Rails configuration
├── spec/                    # RSpec tests
├── k8s/                     # Kubernetes manifests
├── .github/                 # CI/CD workflows
├── docs/                    # Documentation
├── Dockerfile               # Multi-stage build
└── Gemfile                  # Dependencies

Documentation

Document	Description
Decision Guide	How to choose template options
Golden Path Overview	What and why
Getting Started	First steps

Support

• Slack: #platform-help
• Office Hours: Thursdays 2-3pm

Version History

Version	Date	Changes
1.0.0	2025-12	Initial release

---

🤘 Platform Team