Rails Todo API Часть 1

Rails Todo API Часть 1 — это вводный разбор создания простого, но расширяемого REST API на Rails. В этом уроке вы шаг за шагом увидите, как подготовить окружение, настроить маршруты, контроллеры и модели, а также реализовать базовые CRUD‑операции для TODO‑приложения, предназначенного для работы с AngularJS или любым другим фронтендом. Материал подходит как новичкам в Rails, так и разработчикам, желающим укрепить навыки построения API.

Что вы узнаете в этом уроке

Урок объясняет фундаментальные принципы построения API на Rails и помогает быстро перейти к практике.

• Создание базового Rails-приложения для API
• Настройка маршрутов под CRUD‑операции
• Работа с контроллерами и рендеринг JSON‑ответов
• Создание модели Task и миграций
• Обработка ошибок и базовая валидация
• Организация структуры проекта под будущее расширение

Подготовка окружения

Перед созданием API необходимо убедиться, что установлены Ruby, Rails и необходимые зависимости.

Минимальные требования

• Ruby версии 3.0 или выше
• Rails 7.x
• SQLite или PostgreSQL
• Терминал и базовые навыки работы с командной строкой

Создание Rails API-приложения

Вы начнёте с генерации приложения в API‑режиме, что делает проект легче и быстрее.

Генерация проекта

rails new todo_api --api
cd todo_api

Преимущества API‑режима

• Минимальный набор middleware
• Отсутствие лишних view и ассетов
• Оптимизация под возврат JSON

Создание модели и миграции

Модель Task будет основной сущностью TODO‑приложения.

Генерация модели Task

rails g model Task title:string completed:boolean
rails db:migrate

Рекомендации по структуре данных

• Используйте понятные названия полей
• Старайтесь предусмотреть будущие расширения (например, поле description)
• Устанавливайте значения по умолчанию для булевых полей

Настройка маршрутов

Используйте ресурсные маршруты, чтобы сократить код и обеспечить стандартную структуру URL.

Пример маршрутов

resources :tasks

Что это даёт

• Стандартные пути для CRUD
• Упрощение поддержки кода
• Привычная структура для фронтенд‑разработчиков

Создание контроллера и CRUD‑операций

Контроллер отвечает за обработку запросов и возврат JSON‑ответов.

Структура контроллера TasksController

• index — получение списка задач
• show — получение одной задачи
• create — создание новой задачи
• update — обновление существующей задачи
• destroy — удаление задачи

Пример контроллера

class TasksController < ApplicationController
  def index
    render json: Task.all
  end

  def show
    render json: Task.find(params[:id])
  end

  def create
    task = Task.new(task_params)
    if task.save
      render json: task, status: :created
    else
      render json: task.errors, status: :unprocessable_entity
    end
  end

  private

  def task_params
    params.require(:task).permit(:title, :completed)
  end
end

Заключение

В первой части вы создали базовый REST API на Rails, научились работать с моделями, маршрутами и контроллерами. В следующей части мы расширим функциональность, добавим обработку ошибок, улучшенный формат ответов и интеграцию с AngularJS.