CRUD REST API'si Nasıl Oluşturulur ve Test Edilir

Günümüz çağında, verileri verimli bir şekilde yönetmek son derece önemlidir. REST API ile CRUD kullanmak, modern web geliştirmede veri işlemlerinin düzenli ve standart hale getirilmesini sağlar. CRUD (Oluşturma, Okuma, Güncelleme, Silme) işlemleri, verilerin veritabanıyla etkileşim kurmasına yardımcı olur.

Öte yandan, REST (Temsili Durum Aktarımı) API, ağ uygulamalarının tasarımına rehberlik eden bir dizi ilke sağlar. Bu makaledeki ve belgedeki adımları izleyerek bir CRUD REST API oluşturabilir ve API'nizi Apidog ile belgeleyebilir, taklit edebilir ve test edebilirsiniz.

button

CRUD REST API Nedir?

Bir CRUD API, Oluşturma, Okuma, Güncelleme ve Silme temel işlemlerini destekler. Kullanıcıların veya uygulamaların, kayıtları oluşturarak, alarak, güncelleyerek ve silerek bir veritabanı veya veri depolama sistemiyle etkileşim kurmasına olanak tanır.

Örneğin, kullanıcıları yönetmek için bir CRUD API'si aşağıdaki gibi uç noktalara sahip olabilir:

POST /api/users: Yeni bir kullanıcı oluşturun.
GET /api/users/:id: Belirli bir kullanıcının ayrıntılarını alın.
PUT /api/users/:id: Belirli bir kullanıcının tüm ayrıntılarını güncelleyin.
PATCH /api/users/:id: Bir kullanıcının belirli ayrıntılarını güncelleyin.
DELETE /api/users/:id: Belirli bir kullanıcıyı silin.

Bir CRUD REST API Nasıl Oluşturulur?

Bir CRUD REST API oluşturmak birkaç adım içerir. Express.js kullanarak basit bir proje oluşturacağız. Bir REST API'sini başarıyla oluşturmak için tüm adımları dikkatlice izleyin.

Ön Koşullar:

Makinenizde Node.js yüklü olmalıdır. Buradan yükleyebilirsiniz.
Sisteminizde Visual Studio Code gibi bir kod düzenleyiciye ihtiyacınız var.

Adım 1: Bir Node.js projesi başlatın

Komut istemi veya Terminal gibi bir terminal açın ve aşağıdaki komutları yazın. mkdir, projenizin dizinini oluşturacak ve npm init -y, projenizi başlatacaktır.

mkdir crud-rest-api

cd crud-rest-api

npm init -y

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

HTTP isteklerini işlemek ve istekleri ayrıştırmak için gerekli paketleri yükleyin.

npm install express body-parser

Adım 3: Bir Express.js uygulaması oluşturun

Proje dizininizde app.js adında bir dosya oluşturun ve aşağıdaki kodu ekleyin.

const express = require('express');

const bodyParser = require('body-parser');

const app = express();

app.use(bodyParser.json());

// Your routes will go here

const PORT = 3000;

app.listen(PORT, () => {

console.log(`Server is running on port ${PORT}`);

});

Henüz rotalarımızı yazmadığımızı fark edin. Bunu bir sonraki adımda yapacağız.

Adım 4: CRUD işlemlerinizi ayarlayın

CRUD işlemlerini işlemek için rotalarınızı tanımlayın. Bu kodu da app.js'nizin içine koyun.

// Sample data

let items = [

{ id: 1, name: 'Item 1' },

{ id: 2, name: 'Item 2' },

];

// Create

app.post('/items', (req, res) => {

const newItem = req.body;

items.push(newItem);

res.status(201).json(newItem);

});

// Read

app.get('/items', (req, res) => {

res.json(items);

});

// Update

app.put('/items/:id', (req, res) => {

const itemId = parseInt(req.params.id);

const updatedItem = req.body;

items = items.map(item => (item.id === itemId ? updatedItem : item));

res.json(updatedItem);

});

// Delete

app.delete('/items/:id', (req, res) => {

const itemId = parseInt(req.params.id);

items = items.filter(item => item.id !== itemId);

res.sendStatus(204);

});

Adım 5: Uygulamanızı çalıştırın

Şimdi sunucunuzu çalıştırabilirsiniz.

node app.js

Uygulamanız başarıyla oluşturulduysa, terminalinizde buna benzer bir şey görebilirsiniz.

Apidog Nedir?

Apidog , API testini, hata ayıklamayı, tasarımı, taklidi ve dokümantasyon süreçlerini basitleştiren çok yönlü bir API platformudur. Kullanıcı dostu bir arayüz ve zengin bir araç seti ile Apidog, çeşitli projeler üzerinde çalışan ekipler arasındaki işbirliğini geliştirir.

API testini optimize eder, daha kapsamlı değerlendirmelere olanak tanır ve test sonuçları ve yanıtları için JSON/XML şemalarının oluşturulmasını kolaylaştırır.

Özellikleri arasında Apidog, API yanıtlarını ve sonuçlarını belgelemekte, daha sunulabilir dokümantasyon için özelleştirilebilir düzenler sunmaktadır. Platform ayrıca, iddiaların görsel olarak eklenmesini ve test dallarının oluşturulmasını sağlayan, kullanıcı dostu API test araçlarına sahiptir.

Ekip üyeleriyle projeleri paylaşma ve üzerinde çalışma seçeneği aracılığıyla işbirliği çabaları kolaylaştırılır ve grup API'lerini yönetme süreci basitleştirilir. Ek olarak, Apidog API etkinliğini izlemeye yardımcı olur ve taklit yetenekleri, komut dosyası yazma ihtiyacını ortadan kaldırarak daha verimli bir geliştirme deneyimi sağlar.

button

Apidog ile Bir CRUD REST API'si Nasıl Test Edilir?

Artık uygulamanızı oluşturduğunuza göre, API'nizi Apidog'da test edebilirsiniz. Apidog, istek oluşturmak, mesajları ve parametreleri ayarlamak, istekleri kaydetmek ve API hizmetlerine bağlanmak için grafiksel bir arayüz sağlar. API'nizi Apidog ile test etme adımları aşağıda verilmiştir.

button

1. Apidog'da yeni bir proje oluşturun. Bu projeyi istediğiniz gibi adlandırabilirsiniz.

2. Projeniz oluşturulduktan sonra, API bölümüne gidin ve Yeni API'ye tıklayın.

Hangi tür API'yi test etmek istediğinizi seçmek için arama çubuğunun yanındaki + işaretine tıklayın. Bizim durumumuzda, Yeni API'ye bakacağız.

3. Ortamınızı gereksinimlerinize göre ayarladığınızdan emin olun. Örneğimiz için bir Geliştirme Ortamında çalışacağız.

4. API'nizi girin ve "Gönder"e tıklayın. Tüm yanıtları sonuçlarınızda görebileceksiniz.

CRUD REST API ile Apidog Kullanmanın Faydaları

CRUD REST API'lerini test etmek için kullanıldığında Apidog'un sağladığı çeşitli faydalar vardır.

API Dokümantasyonu:

Apidog, CRUD REST API'leriniz için kapsamlı ve etkileşimli API dokümantasyonu oluşturmak için araçlar sağlar. Ayrıca, API'lerini etkili bir şekilde nasıl kullanacaklarını anlamak isteyen geliştiriciler için net ve iyi yapılandırılmış dokümantasyon sağlar.

Test Etme ve Hata Ayıklama:

Apidog, REST API'nizdeki CRUD işlemlerini test etmek ve hata ayıklamak için çeşitli özellikler sunar. Bu, geliştirme ve test sırasında özellikle yararlı olabilir ve geliştiricilerin sorunları daha verimli bir şekilde belirlemesine ve ele almasına olanak tanır.

API Keşfi:

Apidog gibi araçlar, farklı API uç noktalarını keşfetmek ve bunlarla etkileşim kurmak için etkileşimli bir arayüz sağlar. Bu, çeşitli isteklerle denemeler yapmak ve beklenen yanıtları anlamak isteyen geliştiriciler için faydalı olabilir.

Kod Oluşturma:

Apidog dahil olmak üzere bazı API araçları, kod oluşturma yetenekleri sunabilir. Bu, geliştiricilerin API dokümantasyonuna göre farklı programlama dillerinde otomatik olarak kod parçacıkları oluşturarak API'nin uygulamalarına entegre edilmesini kolaylaştırarak yardımcı olabilir.

İşbirliği ve Ekip Çalışması:

Apidog, API dokümantasyonu