JSON rendering in Ruby on Rails - Mini Project: Build & Apply

JSON rendering

📖 Scenario: You are building a simple Rails API that returns user information in JSON format. This is common when creating backend services that frontend apps or other services consume.

🎯 Goal: Create a Rails controller action that renders a JSON response with user data.

📋 What You'll Learn

Create a hash with user data including id, name, and email

Set a status code variable for the HTTP response

Render the JSON response using the render json: method with the user data

Include the status code in the render call

💡 Why This Matters

🌍 Real World

APIs often send data as JSON to frontend apps or other services. Knowing how to render JSON in Rails is essential for backend development.

💼 Career

Backend developers frequently build JSON APIs. This skill is fundamental for roles involving Rails API development or full-stack development.

1

Create user data hash

Create a hash called user with these exact key-value pairs: id: 1, name: 'Alice', and email: '[e-mail]'.

Ruby on Rails

# Create a hash called user with id, name, and email
# Your code here

Need a hint?

Use Ruby hash syntax with symbol keys and string values.

2

Set HTTP status code

Create a variable called status_code and set it to :ok to represent a successful HTTP response.

Ruby on Rails

user = { id: 1, name: 'Alice', email: '[e-mail]' }
# Create a variable status_code and set it to :ok
# Your code here

Need a hint?

Use a symbol :ok for the status code.

3

Render JSON response

Use render json: user to render the user hash as JSON in the controller action.

Ruby on Rails

user = { id: 1, name: 'Alice', email: '[e-mail]' }
status_code = :ok
# Render the user hash as JSON
# Your code here

Need a hint?

Use the render method with json: option.

4

Add status code to render call

Modify the render call to include the status: status_code option so the HTTP response uses the status_code variable.

Ruby on Rails

user = { id: 1, name: 'Alice', email: '[e-mail]' }
status_code = :ok
render json: user # Add status: status_code option here
# Your code here

Need a hint?

Add status: status_code inside the render method call.