LoopBack 4 ile API Oluşturmanın Temelleri: Hızlı ve Basit Bir Rehber

Soner Akgül
3 min readApr 22, 2024

--

LoopBack 4, modern ve güçlü bir API çatısıdır. Node.js ile geliştirme yaparken hızlı ve etkili bir şekilde RESTful API’ler oluşturmanıza olanak tanır. Bu yazımda, LoopBack 4'ün temel kavramlarını ve nasıl kullanılacağını adım adım açıklamaya çalışacağım.

1. Kurulum ve Başlangıç:

LoopBack 4 kullanmaya başlamak için ilk adım, Node.js ve npm’in sisteminizde kurulu olması gerektiğidir. Ardından, aşağıdaki adımları izleyerek yeni bir LoopBack 4 projesi oluşturabilirsiniz:

Adım 1: Node.js ve npm Kurulumu

  • Eğer henüz Node.js ve npm yüklü değilse, resmi web sitesinden indirip kurabilirsiniz. (https://nodejs.org/)
  • Kurulum tamamlandıktan sonra terminal veya komut istemcisinde node -v ve npm -v komutlarını çalıştırarak kurulumun başarılı olup olmadığını kontrol edebilirsiniz.

Adım 2: Yeni Bir LoopBack 4 Projesi Oluşturma

Terminal veya komut istemcisini açıp aşağıdaki komutu çalıştırarak LoopBack 4 CLI aracını global olarak yükleyin:

npm install -g @loopback/cli

Ardından, bir klasör oluşturun ve içine girmek için cd komutunu kullanın:

mkdir my-loopback-project
cd my-loopback-project

Şimdi, lb4 app komutunu çalıştırarak yeni bir LoopBack 4 uygulaması oluşturalım:

Komut çalıştırıldığında, size uygulama adını, proje dizinini ve proje seçeneklerini sormak için bir dizi soru sorulacaktır. İstenilen bilgileri girdiktenten sonra uygulamamız oluşturulacaktır.

Bu adımları takip ettikten sonra, yeni bir LoopBack 4 projesi oluşturmuş olacaksınız ve geliştirmeye hazır hale gelecektir.

2. Veritabanı bağlantısı oluşturma

Loopback 4'ün en keyifli özelliklerinden birisi ise bir çok işlemi kolaylıkla komut satırından yapabiliyor olmanızdır. Veritabanınızı uygulamanız ile ilişkilendirmek için lb4 datasource komutunu çalıştırıyoruz. Yine Loopback 4 bize burada bir dizi sorular soracak ve veritabanınıza erişmek için ilgili bilgileri girmenizi isteyecek. Bir çok veritabanı tipiyle çalıştığından dolayı çok kullanışlı olduğunu söylemek mümkün.

Bilgilerimizi girdikten sonra proje içerisindeki src/datasources klasörü içerisinde bize bir dosya oluşturacak ve gerekli standart konfigürasyonları hazır bir şekilde bize sunacaktır.

3. Model oluşturma

LoopBack 4'te bir model, veritabanı tablosunu temsil eden ve uygulamanızın veri yapısını tanımlayan bir sınıftır. Model oluşturmak için lb4 model komutunu çalıştırabilirsiniz.

Bu komut ile birlikte size modelinizin özellikleri ile ilgili sorular sorulacak.

Modelin adı, property adı, veri tipi, zorunlu mu? değil mi?, primary key atanmalı mı?, otomatik veri basılmalı mı? gibi sorular sorarak modelinizi hızlıca oluşturmanız sağlanacak.

Komut bittikten sonra src/models klasörü içerisinde oluşturmuş olduğunuz modeli görüntüleyebilirsiniz.

4. Repository Oluşturma

LoopBack 4'te bir repository, veritabanı işlemlerini (veri oluşturma, okuma, güncelleme, silme vb.) gerçekleştiren bir sınıftır. Repository’ler, modelinizle doğrudan etkileşim kurmanızı sağlar ve veri erişim katmanınızı yönetmenize yardımcı olur.

Yine aynı şekilde lb4 repository komutu ile repositorynizi oluşturabilirsiniz. Burada size ismini, hangi model ile ilişkilendirmek istediğinizi, hangi veritanabı bağlantısını kullanacağınızı ve uniq olarak kullanmak istediğiniz kolon ismini soracak ve src/repositories klasörü altında ilgili dosyayı otomatik olarak oluşturacaktır.

5. Controller Oluşturma

LoopBack 4'te bir controller, API isteklerini alır, işler ve cevapları oluşturur. Controller’lar, uygulamanızın iş mantığını ve API rotalarını yönetmenize olanak tanır.

lb4 controller komutunu kullanarak controller oluşturmaya başlıyoruz. Bize ilk önce controller adını soracaktır. Adını girdikten sonra ise controllerın nasıl bir yapıda olması gerektiğini soracak. Ya boş bir controller oluşturabilirsiniz ya da default CRUD işlemlerinin yer aldığı bir controller oluşturabilirsiniz.

CRUD işlemlerinin yer aldığı bir controller oluşturduğumuzu varsayarak devam edelim.

6. Migration İşlemleri

LoopBack 4'te migration işlemleri, veritabanı şemasındaki değişiklikleri yönetmek için kullanılır. Veritabanı modelinizde yapılan değişiklikleri, veritabanına uygulamak veya geri almak için migration işlemlerini kullanabilirsiniz.

Komut satırına npm run migrate yazıp entera bastıktan sonra sizin için migration işlemleri gerçekleşmiş olacak ve veritabanınıza değişiklikler uygulanacaktır.

7. En Keyifli An

Evet en keyifli an tam da burada yer alıyor. npm run start komutunu çalıştırdığınız zaman projeniz ayaklanıyor ve https://localhost:3000/explorer üzerinden doğrudan bir swagger sayfası açıyor.

8. Derleme İşlemleri

npm run build komutu ile projenizi derleyip çalışmaya hazır hale getiriyorsunuz. Host edeceğiniz platforma göre konfigürasyonlarınızı yapıp kolaylıkla projenizi yayınlayabilirsiniz.

Bu makalede, LoopBack 4'ü kullanarak API oluşturmanın temellerini adım adım öğrendiniz. Node.js ekosistemi içinde güçlü ve esnek bir çözüm olan LoopBack 4, modern RESTful API’lerin hızlı bir şekilde oluşturulmasını sağlar.

Makalemizde, LoopBack 4'ün kurulumundan başlayarak, model oluşturma, controller ve repository tanımlama, veritabanı bağlantısı kurma, migration işlemleri ve son olarak da uygulamanızı derleme ve çalıştırma adımlarını inceledik.

Artık LoopBack 4'ü kullanarak kendi projenizi oluşturma ve geliştirme yolunda ilk adımlarınızı atmaya hazırsınız. LoopBack 4'ün kapsamlı belgeleri ve topluluk desteği sayesinde, daha karmaşık senaryoları ele almak ve uygulamanızı daha da geliştirmek için tüm dokümantasyona buradan ulaşabilirsiniz.

LoopBack 4 ile API geliştirmeye başlamak heyecan verici bir deneyim olabilir. API’lerinizi hızlı ve güvenli bir şekilde oluşturmak için LoopBack 4'ü kullanarak, projelerinizde yeni kapılar açabilirsiniz.

Umarım bu makale, LoopBack 4'ün temel kavramlarını anlamanıza ve kendi projelerinizde başarılı bir şekilde kullanmanıza yardımcı olmuştur.

Projenin örneğine buradan ulaşabilirsiniz.

Hoşça kalın….

--

--