Membangun API dengan Ruby on Rails: Panduan Lengkap untuk Developer

·

by

Rebecca

API dengan Ruby on Rails

Ruby on Rails (Rails) dikenal sebagai framework yang sangat produktif untuk membangun aplikasi full-stack, namun popularitasnya sebagai alat untuk menciptakan Application Programming Interface (API) yang kuat semakin meningkat. Rails menyediakan fondasi yang solid, sintaks yang elegan, dan ekosistem yang kaya untuk membangun API RESTful yang cepat dan maintainable. Artikel ini akan memandu para developer melalui langkah-langkah penting dalam membangun API dengan Rails.

Mengapa Memilih Rails untuk API?

Rails, khususnya pada versi 5 ke atas, memperkenalkan mode API-only, yang secara drastis mengurangi overhead dan hanya menyertakan middleware yang benar-benar dibutuhkan untuk API. Ini berarti kinerja yang lebih cepat dan penggunaan sumber daya yang lebih sedikit. Keunggulan utamanya meliputi:

  • Konvensi di atas Konfigurasi: Rails mengikuti pola desain yang konsisten, yang mempercepat pengembangan dan membuat kode lebih mudah dipahami.

  • Active Record: ORM (Object-Relational Mapping) yang kuat memudahkan interaksi dengan database.

  • Ekosistem Gem: Ribuan gem (paket) siap pakai untuk otentikasi (misalnya Devise, JWT), serialisasi (misalnya Fast JSON API), dan pengujian.

Langkah 1: Inisiasi Proyek Rails API-Only

Langkah pertama adalah membuat boilerplate aplikasi dalam mode API. Gunakan perintah berikut:

Bash

rails new nama_proyek_api --api --database=postgresql

Opsi --api akan memberitahu Rails untuk:

  1. Hanya menyertakan Action Controller dan bukannya Action View, Action Helpers, dan middleware terkait browser lainnya.

  2. Mengkonfigurasi generator untuk melewatkan pembuatan view dan helper saat membuat controller dan scaffold.

Langkah 2: Otentikasi dan Otorisasi

API modern harus aman. Karena tidak ada sesi berbasis cookie di API, kita beralih ke metode otentikasi stateless. Pendekatan yang paling populer adalah menggunakan JSON Web Tokens (JWT).

  1. Tambahkan gem jwt ke Gemfile.

  2. Buat endpoint /login yang akan menerima kredensial pengguna.

  3. Setelah kredensial divalidasi, controller akan membuat dan mengembalikan JWT kepada klien.

    • JWT harus dienkripsi dengan kunci rahasia (Rails.application.credentials.secret_key_base).

    • Token yang diterima klien akan dikirimkan dalam header Authorization (biasanya sebagai Bearer Token) di setiap permintaan berikutnya.

  4. Buat concern atau base controller yang akan mendekode JWT dari header dan menetapkan pengguna yang sedang login (misalnya current_user) sebelum mengizinkan akses ke endpoint lain.

Langkah 3: Serialisasi Data

Secara default, Rails akan merender objek Active Record ke dalam bentuk JSON. Namun, untuk API yang efisien dan terstruktur, kita perlu mengontrol bagaimana data direpresentasikan, terutama untuk mengelola hubungan antar objek (nested relationships) dan menghindari pengiriman data yang berlebihan (N+1 query problem).

  • Fast JSON API: Ini adalah gem yang sangat direkomendasikan karena cepat dan mengikuti standar JSON:API.

  • Buat serializer untuk setiap model (misalnya UserSerializer, PostSerializer). Serializer ini mendefinisikan atribut mana yang harus disertakan dan bagaimana relationship (has_many, belongs_to) harus ditampilkan.

Ruby

# Contoh PostSerializer
class PostSerializer
  include FastJsonapi::ObjectSerializer
  attributes :title, :content, :created_at
  belongs_to :user
end

Langkah 4: Perutean dan Controller

  • Perutean (Routing): Gunakan sintaks resource standar di config/routes.rb untuk mendefinisikan endpoint RESTful.

Ruby

# config/routes.rb
Rails.application.routes.draw do
  namespace :v1 do # Versi API
    resources :posts, only: [:index, :show, :create, :update, :destroy]
    post '/login', to: 'sessions#create'
  end
end

  • Controller: Pastikan controller Anda menggunakan metode strong parameters untuk memfilter input data dan menggunakan serializer untuk output data.

Ruby

# app/controllers/v1/posts_controller.rb
class V1::PostsController < ApplicationController
  before_action :authenticate_user! # Pastikan pengguna sudah diotentikasi

  def index
    posts = Post.all
    render json: PostSerializer.new(posts).serialized_json
  end
  # ... metode lain seperti create, show, update, destroy
end

Langkah 5: Pengujian (Testing)

Pengujian adalah bagian krusial. Rails menyediakan Minitest secara default, tetapi banyak developer memilih RSpec untuk sintaks yang lebih ekspresif.

Pastikan untuk menguji:

  1. Response Status: Verifikasi kode status HTTP (misalnya 200 OK, 201 Created, 401 Unauthorized, 404 Not Found).

  2. Payload JSON: Pastikan struktur dan konten JSON yang dikembalikan sudah benar dan konsisten dengan spesifikasi serializer.

  3. Otentikasi: Uji akses ke endpoint yang dilindungi tanpa JWT dan dengan JWT yang valid.

Kesimpulan

Ruby on Rails, dengan mode API-only dan ekosistemnya yang matang, adalah pilihan yang fantastis untuk membangun API yang efisien, terstruktur, dan mudah dikembangkan. Dengan mengikuti panduan ini—mulai dari inisiasi proyek, implementasi otentikasi JWT, serialisasi data dengan Fast JSON API, hingga pengujian yang ketat—Anda akan memiliki semua alat yang dibutuhkan untuk menghadirkan API yang andal dan siap untuk aplikasi frontend modern (React, Vue, mobile).

Baca juga : Membangun API dengan Ruby on Rails: Panduan Komprehensif untuk Developer