Налаштування API-тільки Rails Додатку

У сучасному світі веб-розробки, створення API-тільки додатків стає все більш популярним. Це дозволяє розробникам зосередитися на створенні потужних бекенд-систем, які можуть взаємодіяти з різними фронтенд-технологіями. У цій статті ми розглянемо, як налаштувати API-тільки Rails додаток, крок за кроком.

Що таке API-тільки додаток?

API-тільки додаток — це веб-додаток, який надає лише API (інтерфейс програмування додатків) для взаємодії з клієнтськими додатками. Це означає, що у вас немає традиційного фронтенду, а лише бекенд, який обробляє запити та відповіді у форматі JSON або XML.

Переваги API-тільки додатків

Гнучкість: Ви можете використовувати різні технології для фронтенду, такі як React, Vue.js або Angular.
Масштабованість: Легше масштабувати бекенд, оскільки він не залежить від конкретного фронтенду.
Швидкість розробки: Можна швидше розробляти та тестувати, оскільки ви можете працювати над фронтендом і бекендом паралельно.

Крок 1: Створення нового Rails проекту

Перш ніж почати, переконайтеся, що у вас встановлені Ruby та Rails. Ви можете перевірити це, виконавши наступні команди в терміналі:

ruby -v
rails -v

Якщо все в порядку, ви можете створити новий Rails проект, використовуючи команду:

rails new my_api_app --api

Ключ --api вказує Rails, що ви хочете створити API-тільки додаток. Це автоматично налаштує ваш проект для роботи з API, зменшуючи кількість непотрібних компонентів.

Крок 2: Налаштування бази даних

Rails підтримує кілька баз даних, але для цього прикладу ми будемо використовувати SQLite. Відкрийте файл config/database.yml і переконайтеся, що налаштування виглядають так:

default: &default
  adapter: sqlite3
  pool: 5
  timeout: 5000

development:
  <<: *default
  database: db/development.sqlite3

test:
  <<: *default
  database: db/test.sqlite3

production:
  <<: *default
  database: db/production.sqlite3

Тепер створіть базу даних, виконавши команду:

rails db:create

Крок 3: Створення моделі

Давайте створимо просту модель для нашого API. Припустимо, ми хочемо створити модель Article. Використовуйте команду генератора для створення моделі:

rails generate model Article title:string body:text

Ця команда створить файл міграції, який ви можете знайти в db/migrate. Тепер виконайте міграцію, щоб створити таблицю в базі даних:

rails db:migrate

Крок 4: Налаштування контролера

Тепер, коли у нас є модель, давайте створимо контролер для обробки запитів. Використовуйте команду генератора для створення контролера:

rails generate controller Articles

Відкрийте файл app/controllers/articles_controller.rb і додайте наступні методи:

class ArticlesController < ApplicationController
  def index
    @articles = Article.all
    render json: @articles
  end

  def show
    @article = Article.find(params[:id])
    render json: @article
  end

  def create
    @article = Article.new(article_params)
    if @article.save
      render json: @article, status: :created
    else
      render json: @article.errors, status: :unprocessable_entity
    end
  end

  def update
    @article = Article.find(params[:id])
    if @article.update(article_params)
      render json: @article
    else
      render json: @article.errors, status: :unprocessable_entity
    end
  end

  def destroy
    @article = Article.find(params[:id])
    @article.destroy
    head :no_content
  end

  private

  def article_params
    params.require(:article).permit(:title, :body)
  end
end

Крок 5: Налаштування маршрутизації

Тепер, коли у нас є контролер, давайте налаштуємо маршрути. Відкрийте файл config/routes.rb і додайте наступний код:

Rails.application.routes.draw do
  resources :articles
end

Це створить стандартні маршрути для нашого контролера Articles, включаючи index, show, create, update та destroy.

Крок 6: Тестування API

Тепер, коли все налаштовано, ви можете протестувати свій API. Запустіть сервер Rails:

rails server

Відкрийте нову вкладку терміналу і використовуйте curl або Postman для тестування вашого API. Наприклад, щоб отримати всі статті, виконайте:

curl http://localhost:3000/articles

Для створення нової статті, ви можете використовувати:

curl -X POST http://localhost:3000/articles -H "Content-Type: application/json" -d '{"article": {"title": "My First Article", "body": "This is the body of my first article."}}'

Крок 7: Додаткові налаштування

Ви можете додати додаткові функції до вашого API, такі як аутентифікація, авторизація, обробка помилок та документація. Ось кілька корисних гемів, які можуть допомогти:

Devise: для аутентифікації користувачів.
Pundit: для авторизації.
ActiveModelSerializers: для форматування JSON-відповідей.
Rswag: для автоматичної документації API.

Висновок

Створення API-тільки Rails додатку — це простий і ефективний спосіб розробки сучасних веб-додатків. Ви можете легко налаштувати свій проект, створити моделі, контролери та маршрути, а також протестувати свій API. Сподіваємося, що ця стаття була корисною для вас, і ви зможете створити свій власний API-тільки додаток на Rails!