Node.js ve Express ile REST API Nasıl Oluşturulur

REST API nedir?

REST API, istemci ve sunucu uygulamaları arasında veri alışverişini kolaylaştırmak için HTTP protokolünü kullanan bir mimari stildir. Mimari, tek tip arayüz, durumsuz iletişim ve kaynaklar üzerinde işlem yapmak için standart HTTP yöntemlerinin (GET, POST, PUT, DELETE gibi) kullanımı gibi bir dizi kısıtlama ve ilke etrafında tasarlanmıştır.

Temel REST API kavramları

Kaynaklar:
Kaynaklar, REST'teki temel birimlerdir. Her kaynak bir URL (Benzersiz Adres) ile tanımlanır. Örneğin, kitapları yönetmek için kullanılan bir REST API'sinde, bir kitap şu konumda bulunan bir kaynak olabilir: /kitaplar/1 Mevcut.
HTTP yöntemleri:
REST API'leri kaynaklarla etkileşim kurmak için standart HTTP yöntemlerini kullanır:
- ELDE ETMEK: Sunucudan veri al (örneğin, kitapların listesini veya belirli bir kitabı al).
- POSTALAMAK: Yeni bir kaynak oluşturmak için sunucuya veri gönderme (örneğin yeni bir kitap ekleme).
- KOYMAK: Mevcut bir kaynağı yeni verilerle güncelleyin (örneğin, mevcut bir kitabın ayrıntılarını güncelleyin).
- SİLMEK: Sunucudan bir kaynağı silin (örneğin, bir kitabı silin).
Vatansızlık:
İstemciden sunucuya yapılan her istek, sunucunun bu isteği yerine getirmek için ihtiyaç duyduğu tüm bilgileri içermelidir. Sunucu, istekler arasında istemci oturumuyla ilgili herhangi bir durum veya bilgi depolamaz. Bu özellik, REST API'lerini ölçeklenebilir ve bakımı kolay hale getirir.
Temsiller:
Kaynaklar JSON, XML veya düz metin gibi çeşitli biçimlerde temsil edilebilir. JSON, hafif yapısı ve kullanım kolaylığı nedeniyle en yaygın biçimdir.
Tekdüze Arayüz:
REST API'leri, kaynaklarla tutarlı bir şekilde etkileşim kurmak için tek tip bir arayüz sağlamak üzere tasarlanmıştır. Bunlar şunları içerir:
- Kaynak tanımlama: URL'ler kaynakları benzersiz bir şekilde tanımlar.
- Görünümler aracılığıyla kaynakları yönetme: İstemciler, kaynaklarla etkileşim kurmak için görünümleri kullanır (örneğin, bir kaynağı oluşturmak veya güncellemek için JSON verileri göndermek).
- Kendini tanımlayan mesajlar: Her mesaj, nasıl işlendiğini açıklayacak kadar bilgi içerir.
- Uygulama Durum Motoru Olarak Hipermedya (HATEOAS): İstemciler, kaynaklarla tamamen sunucunun dinamik olarak sağladığı hiper bağlantılar aracılığıyla etkileşim kurar.
İstemci-sunucu mimarisi:
REST, istemci ve sunucuyu ayırır ve bunların bağımsız olarak gelişmesine olanak tanır.
Önbellek yeteneği:
Bir REST API'den gelen yanıtlar, önbelleğe alınabilir veya önbelleğe alınamaz olarak açıkça işaretlenebilir. Bu özellik, istemcilerin yanıtları önbelleğe alarak performansı artırmalarına ve tekrarlanan istek gönderme ihtiyacını azaltmalarına olanak tanır.

REST API'nin gerçek dünyadan bir örneği

İşte bir kütüphane için REST API uç noktasına bir örnek:

1. Tüm kitapların bir listesini alın

Adres: /kitaplar

HTTP yöntemi: ELDE ETMEK

[
{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1949
},
{
"id": 2,
"title": "To Kill a Mockingbird",
"author": "Harper Lee",
"published_year": 1960
}
]

2. Belirli bir kitabın ayrıntılarını alın

Adres: /kitaplar/{id}

HTTP yöntemi: ELDE ETMEK

{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1949
}

3. Yeni bir kitap ekleyin

Adres: /kitaplar

HTTP yöntemi: POSTALAMAK

Rica etmek:

POST /books İçerik Türü: application/json

{
"title": "Brave New World",
"author": "Aldous Huxley",
"published_year": 1932
}

Cevap:

{
"id": 3,
"title": "Brave New World",
"author": "Aldous Huxley",
"published_year": 1932
}

4. Mevcut bir kitabı güncelleyin

Adres: /kitaplar/{id}

HTTP yöntemi: KOYMAK

Rica etmek:

PUT /books/1 İçerik Türü: application/json

PUT /books/1
Content-Type: application/json
{
"title": "1984",
"author": "George Orwell",
"published_year": 1948
}

Cevap:

{
"id": 1,
"title": "1984",
"author": "George Orwell",
"published_year": 1948
}

Node.js nedir?

Node.js, popüler Express çerçevesiyle birleşerek REST API'leri oluşturmayı güçlü ve verimli hale getiren sunucu taraflı bir JavaScript çalışma zamanı ortamıdır. Bu makalede, Node.js ve Express kullanarak bir REST API oluşturma sürecini adım adım, pratik örneklerle birlikte ele alacağız.

REST API'leri oluşturmak için neden Node.js ve Express kullanmalısınız?

Yüksek performans ve ölçeklenebilirlik: Node.js, JavaScript'i doğrudan makine koduna derleyen ve yüksek hız ve performans sağlayan Google'ın V8 motoru üzerine kuruludur. Node.js'nin engellemeyen G/Ç modeli, çok sayıda eşzamanlı bağlantıyı yönetmek için verimlidir.
JavaScript her yerde: Node.js, geliştiricilerin hem istemci hem de sunucu geliştirmelerinde JavaScript kullanmalarına olanak tanır; bu da öğrenmeyi kolaylaştırır ve geliştirme sürecini hızlandırır.
Hızlı geliştirme döngüsü: Node.js'yi Express ile birleştirmek, hızlı uygulama geliştirmeyi mümkün kılar. Express, web ve mobil uygulamalar için sağlam bir özellik seti sağlayan minimal ve esnek bir çerçevedir.
Geniş ekosistem: Node.js, daha hızlı geliştirme yapmanıza yardımcı olan npm aracılığıyla zengin bir kütüphane ve modül setine sahiptir.
Gerçek Zamanlı Yetenekler: Node.js, sohbet ve canlı güncellemeler gibi gerçek zamanlı uygulamalar oluşturmada mükemmeldir.

Node.js ile REST API oluşturmaya yönelik adım adım kılavuz

Adım 1: Bir proje oluşturun

Öncelikle projeniz için yeni bir dizin oluşturun ve npm ile başlatın:

mkdir my-rest-api
cd my-rest-api
npm init -y

Adım 2: Bağımlılıkları yükleyin

REST API'nizi çalışır duruma getirmek için birkaç paket yükleyin:

İfade etmek: Node.js için web uygulama çerçevesi.
Gövde ayrıştırıcısı: Gelen isteklerin gövdesini ayrıştırmak için bir ara yazılım.
Nodemon (isteğe bağlı): Geliştirme sırasında sunucuyu otomatik olarak yeniden başlatmaya yarayan bir araç.

npm install express body-parser
npm install --save-dev nodemon

Adım 3: Hızlı Bir Uygulama Oluşturun

Bir Express uygulaması oluşturun ve temel bir sunucu kurun:

const express = require('express');
const bodyParser = require('body-parser');
const app = express();
app.use(bodyParser.json());
const port = process.env.PORT || 3000;
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});

Adım 4: Rotaları tanımlayın

Rotalar, API uç noktalarını tanımlar. Örneğin, bir GET isteği için bir rota:

app.get('/api/hello', (req, res) => {
res.json({ message: 'Hello, World!' });
});

Adım 5: API'yi uygulayın

API'nizi Nodemon veya Node.js kullanarak çalıştırın:

npm start

Eğer http://localhost:3000/api/hello Erişim sağladığınızda "Merhaba dünya!" mesajını göreceksiniz.

Adım 6: Daha fazla rota ekleyin

Kullanışlı bir API oluşturmak için daha fazla rota tanımlamanız ve kaynaklar üzerinde CRUD (Oluşturma, Okuma, Güncelleme, Silme) işlemlerini uygulamanız gerekir. Örneğin, Yapılacaklar Listesi için basit bir API:

let todos = [];
app.get('/api/todos', (req, res) => {
res.json(todos);
});
app.post('/api/todos', (req, res) => {
const newTodo = req.body;
todos.push(newTodo);
res.status(201).json(newTodo);
});
// Implement PUT and DELETE as an exercise

Bu örnekte, yeni görevleri listelemek ve oluşturmak için yollar tanımlanmıştır. Aşağıdaki yöntemleri uygulayabilirsiniz: KOYMAK Ve SİLMEK Görevleri güncellemek ve silmek için genişletin.

Adım 7: API Testi

API'nizin düzgün çalıştığından emin olmak için test etmeniz çok önemlidir. Postacı Veya Apidog Taleplerinizi iletmenize ve yanıtları incelemenize yardımcı olabilirler.

Adım 8: API'yi dağıtın

API'nizi başkalarıyla paylaşmaya hazır olduğunuzda, bunu Heroku, AWS veya Azure gibi platformlarda dağıtabilirsiniz.

Apidog kullanarak REST API oluşturmanın alternatif bir yolu

Apidog, REST API geliştirme sürecini basitleştirir ve test, dokümantasyon, güvenlik ve performans optimizasyonu gibi özellikler sunar. Apidog'u kullanma adımları şunlardır:

Adım 1: Apidog'u indirin ve yükleyin

Öncelikle Apidog'da bir hesap oluşturmanız gerekiyor. Bunu Apidog web sitesi üzerinden ve "Kayıt Ol" butonuna tıklayarak yapabilirsiniz.

Adım 2: API Oluşturun

Proje içinde yeni bir API oluşturabilirsiniz. Dokümantasyon, API'nizin kaynaklarını, işlemlerini ve parametrelerini açıklayan bir haritadır.

Adım 3: REST API parametrelerini ayarlayın

HTTP yöntemlerini, istek/yanıt modellerini, sorgu parametrelerini, başlıkları vb. doldurun.

Adım 4: REST API'yi test etme

API’yi geliştirdikten sonra “Gönder” butonuna tıklayarak test edebilirsiniz.

Node.js'deki REST API hakkında Sıkça Sorulan Sorular

1. Node.js'de REST API için en iyi framework hangisidir?

Feathers, Nest, LoopBack ve Moleculer harika framework'ler olsa da, Express'i en iyi seçenek yapan nedenler var:

Tüm özellikler: Express, MVC mimarisi, güçlü yönlendirme yetenekleri ve yerleşik ara yazılım gibi özellikler sunuyor.
Güçlü toplum desteği: Daha hızlı ve verimli çalışmanıza yardımcı olan geniş bir topluluğa sahiptir.
Kullanıcı dostu: Express'in kurulumu, öğrenmesi ve kullanımı kolaydır, bu da onu yeni başlayanlar için ideal kılar.

2. REST API için Go mu yoksa Node.js mi kullanmalıyız?

Go ile Node.js arasında seçim yapmak, performans gereksinimleri, geliştirme hızı ve ekibinizin uzmanlığı gibi çeşitli faktörlere bağlıdır.

Go ne zaman uygundur:

Yüksek performansa ve verimliliğe ihtiyacınız var.
Uygulamanızın çok sayıda eş zamanlı işlemi yönetmesi gerekiyor.
Daktilo dilini tercih edersiniz.

Node.js ne zaman uygun olur:

Hızlı bir geliştirme döngüsüne ihtiyacınız var.
Uygulamanız G/Ç odaklıdır.
Projenin tamamında JavaScript kullanıyorsunuz.

3. Node.js API geliştirmeye uygun mudur?

Evet, Node.js, bloke etmeyen mimarisi ve Express gibi araçları sayesinde RESTful API'leri oluşturmak için oldukça uygundur.

4. REST API'yi uygulamak için en iyi dil hangisidir?

REST API'yi uygulamak için en iyi dil, projenizin özel ihtiyaçlarına, geliştirme ekibinizin uzmanlığına ve mevcut teknoloji yığınınıza bağlıdır.

Hızlı prototipleme için: Python (Flask veya Django framework ile) veya Ruby (Rails framework ile).
Yüksek performans için: Git veya C# (ASP.NET Core ile).
Güçlü bir ekosistem ve topluluk desteği için: JavaScript (Node.js ile) veya PHP.
Kurumsal düzeydeki uygulamalar için: Java veya C#.

5. Node.js REST API kullanıyor mu?

Node.js, sunucu taraflı bir JavaScript çalışma ortamıdır ve yerleşik REST API özelliklerine sahip değildir. Ancak, engellemeyen mimarisi ve Express.js gibi çerçevelerin varlığı sayesinde Node.js, REST API'leri oluşturmak için yaygın olarak kullanılmaktadır.

6. İnsanlar hala Express'i kullanıyor mu?

Evet, Express.js hala REST API'leri ve web uygulamaları geliştirmek için yaygın olarak kullanılıyor.

7. Next.js, Express'in yerine mi geçiyor?

Next.js ve Express, web geliştirme ekosisteminde farklı amaçlara hizmet eden araçlardır ve biri diğerinin yerine geçemez. Next.js, sunucu taraflı görselleştirme ve React uygulamaları oluşturmak için daha yaygın olarak kullanılırken, Express rotaları yönetmek ve RESTful API'leri oluşturmak için daha uygundur.

8. Node.js API geliştirmeye uygun mudur?

Evet, Node.js, engelleyici olmayan mimarisi ve çok sayıda eşzamanlı bağlantıyı yönetebilme özelliği sayesinde API geliştirme için harikadır. Ayrıca, Express.js gibi çerçevelerle, Node.js ile RESTful API'ler oluşturmak kolay ve hızlıdır.

9. Node.js API'leri için en iyi veritabanı hangisidir?

Node.js API'leri için en iyi veritabanı, projenizin özel ihtiyaçlarına bağlıdır:

MongoDB: Esneklik ve Node.js ile kolay entegrasyon için.
PostgreSQL ve MySQL: Güçlü uyumluluk ve SQL yetenekleri için.
SQLite: Basit uygulamalar veya gömülü kullanımlar için.

Uygulama ihtiyaçlarınızı değerlendirip doğru veritabanını seçmeniz projenizin başarısını garanti altına almanıza yardımcı olacaktır.

Sonuç

Node.js ve Express kullanarak bir REST API oluşturmak, her web geliştiricisi için güçlü bir beceridir. Bu makalede, projenin kurulumundan rotaların tanımlanmasına ve hatta test edilip dağıtılmasına kadar tüm temel adımları ele aldık. Başarının anahtarının pratik olduğunu unutmayın, bu yüzden kendi API'lerinizi oluşturmaktan ve farklı özellikleri denemekten çekinmeyin. Bu temel sayesinde, RESTful API'lerle sağlam ve ölçeklenebilir web uygulamaları geliştirmeye hazır olacaksınız.

Node.js ve Express ile REST API nasıl oluşturulur?