Why API versioning in Ruby on Rails? - Purpose & Use Cases

The Big Idea

What if you could improve your API without ever breaking your users' apps?

The Scenario

Imagine you built an app with an API that many other apps use. Now you want to add new features or fix bugs without breaking the old apps that rely on your API.

The Problem

Without versioning, every change risks breaking existing users. You must keep old code forever or confuse clients with unexpected behavior. It becomes a mess to maintain and update.

The Solution

API versioning lets you keep old versions working while improving or changing the API in new versions. Clients can choose which version to use, so updates don't break anything.

Before vs After

✗ Before

def show
  # old behavior
end
# changing this breaks old clients

✓ After

namespace :v1 do
  resources :items
end
namespace :v2 do
  resources :items
end

What It Enables

It enables smooth, safe API evolution so your app can grow without breaking existing users.

Real Life Example

A weather app uses your API v1 to get forecasts. You add new data in v2 without stopping v1 users from getting their info.

Key Takeaways

Manual API changes break existing users easily.

Versioning keeps old and new APIs working side by side.

Clients pick the version they need, making updates safe.

Practice

1. What is the main purpose of API versioning in a Rails application?

easy

A. To change the database schema automatically

B. To allow updates without breaking existing API users

C. To speed up database queries

D. To improve the UI design of the application

Solution

1. Step 1: Understand API versioning concept

   API versioning allows developers to release new API features or changes without affecting users who rely on older versions.

2. Step 2: Identify the main benefit

   This prevents breaking changes and keeps old clients working while new clients can use updated features.

3. Final Answer:

   To allow updates without breaking existing API users -> Option B

4. Quick Check:

   API versioning = safe updates [OK]

Hint: API versioning = safe updates without breaking old clients [OK]

Common Mistakes:

• Thinking it speeds up database queries
• Confusing with UI improvements
• Assuming it changes database schema automatically

2. Which of the following is the correct way to define API versioning in Rails routes using namespaces?

easy

A. version :v1 do
resources :users
end

B. scope :v1 do
resources :users
end

C. namespace :v1 do
resources :users
end

D. api_version :v1 do
resources :users
end

Solution

1. Step 1: Recall Rails routing syntax for versioning

   Rails uses the namespace method to group routes under a version folder like v1.

2. Step 2: Check each option

   Only namespace :v1 do ... end is valid Rails syntax for versioning routes.

3. Final Answer:

   namespace :v1 do resources :users end -> Option C

4. Quick Check:

   Rails versioning uses namespace [OK]

Hint: Use namespace for version folders in routes [OK]

Common Mistakes:

• Using non-existent 'version' or 'api_version' methods
• Using scope without path or module options
• Confusing namespace with scope

3. Given this routes setup in Rails:

namespace :v1 do
  get 'status', to: 'health#show'
end
namespace :v2 do
  get 'status', to: 'health#show'
end

What will GET /v2/status call?

medium

A. The show action in HealthController inside V2 module

B. The show action in the main HealthController without module

C. A routing error because v2 is not defined

D. The show action in HealthController inside V1 module

Solution

1. Step 1: Understand namespace routing effect

   Each namespace creates a module scope. So v2 routes call controllers inside V2:: module.

2. Step 2: Match the route to controller

   GET /v2/status calls V2::HealthController#show, not the v1 or main controller.

3. Final Answer:

   The show action in HealthController inside V2 module -> Option A

4. Quick Check:

   Namespace v2 routes call V2 controllers [OK]

Hint: Namespace URL matches controller module [OK]

Common Mistakes:

• Assuming v2 calls v1 controller
• Thinking it causes routing error
• Ignoring module scoping in namespaces

4. You have this routes file snippet:

namespace :v1 do
  resources :products
end

namespace :v1 do
  resources :orders
end

What is the problem with this code?

medium

A. You must use scope instead of namespace for versioning

B. Rails does not allow multiple namespaces with the same name

C. Resources inside namespaces must be singular, not plural

D. Duplicate namespace declarations can be merged into one block

Solution

1. Step 1: Analyze namespace usage

   Rails allows multiple namespace blocks with the same name but it's better style to merge them.

2. Step 2: Identify best practice

   Merging namespace :v1 blocks into one improves readability and avoids confusion.

3. Final Answer:

   Duplicate namespace declarations can be merged into one block -> Option D

4. Quick Check:

   Merge same namespaces for clarity [OK]

Hint: Merge same namespaces into one block [OK]

Common Mistakes:

• Thinking Rails forbids multiple same namespaces
• Using singular resources incorrectly
• Confusing namespace with scope

5. You want to support two API versions in your Rails app: v1 and v2. v1 returns user data with name only, but v2 adds email. How should you organize your controllers to handle this cleanly?

hard

A. Create separate controllers under app/controllers/v1/users_controller.rb and app/controllers/v2/users_controller.rb with different responses

B. Use a single controller and check version in each action to decide response

C. Put all logic in the model and use one controller for both versions

D. Use middleware to rewrite responses after controller runs

Solution

1. Step 1: Understand version separation best practice

   Separate controllers per version keep code clean and maintainable, avoiding complex conditionals.

2. Step 2: Apply Rails versioning pattern

   Place controllers in versioned folders like v1/users_controller.rb and v2/users_controller.rb to handle different responses.

3. Final Answer:

   Create separate controllers under app/controllers/v1/users_controller.rb and app/controllers/v2/users_controller.rb with different responses -> Option A

4. Quick Check:

   Separate controllers per version = clean code [OK]

Hint: Use separate controllers per version folder [OK]

Common Mistakes:

• Using one controller with many version checks
• Putting version logic in models
• Trying to rewrite responses with middleware