Python ve JavaScript Kullanarak Bir API Nasıl Test Edilir

Bir uygulama programlama arabirimi (API) seçmek ile onunla çalışıp çalışamayacağınıza karar vermek arasında ince bir çizgi vardır. Çoğu REST API'si genel bir mimariye sahiptir ve ortak bir istek yolu iş parçacığına sahiptir. Ancak bazı API'ler standarttan sapıyor. Sonuç olarak, kullanımları zorlaşır.

Bu nedenle, tüm yazılımınızı bir API üzerinde oluşturmadan önce kalite kontrolleri yapmanız ve düzgün çalıştığından emin olmanız gerekir. Peki API testi nedir ve bir API'yi nasıl test edebilirsiniz?

API Testi Nedir?

API testi, onu kullanmak isteyen program için ideal olup olmadığını görmek için bir API'nin işlevselliği, güvenliği, ölçeklenebilirliği, hızı ve daha fazlasının ilk değerlendirmesini içerir. Ancak yüzeysel olarak, çeşitli uç noktaları aracılığıyla istekte bulunduğunuzda uygun yanıtları gönderip göndermediğini görmek için test etmeyi gerektirebilir.

Yapısına bağlı olarak, bir API'yi test ederken ilgili uç noktalarına isteklerde bulunacaksınız (Al, Gönder, Güncelle veya Sil). API testi sırasında kontrol edilecek birçok ölçüm vardır. Ancak başlangıç ​​düzeyinde, bir API'nin bütünlüğünü durum kodundan doğrulamak ve doğru verileri alıp kabul ettiğinden emin olmak istersiniz .

Bu amaçla, herhangi bir web isteği gibi, bir API de 200, 400 veya 500 durum kodunu veya hatta başkalarını döndürebilir.

Çoğu API, yüklerini sunmak için JSON yanıtlarını kullanır. Amaca bağlı olarak, diğerleri XML, çok parçalı veya HTML yüklerini kabul edebilir ve yanıt verebilir.

Python ve JavaScript Kullanarak Bir API Nasıl Test Edilir

İnternette birçok grafiksel kullanıcı arayüzü (GUI) API test aracı olmasına rağmen, yazılı scriptler ile bir API'yi daha eleştirel bir şekilde değerlendirebilirsiniz.

Bir API, belgelerinde izin verdiği istek türlerini söyler ve bunlara ilgili uç noktalar sağlar. Böylece uygun istek yöntemlerini kullanarak bunları yakalayabilir ve test edebilirsiniz.

İlgili: REST API Nedir ve Uygulamanız veya Web Siteniz için Nasıl Veri Alabilirsiniz?

Gerçek üretim aşamasının aksine, API testi kabadır. Bu nedenle, API'yi üretim için çalıştırırken olduğu kadar spesifikliğe ihtiyacınız yoktur. API testinin farklı türleri olsa da, bu makalede daha çok yanıt doğrulama testlerine odaklanacağız.

Bu öğreticide JavaScript'in getirme ve Python'un istek kitaplığını kullanarak sahte bir mağaza API'sini test edeceğiz . Bunu yaparken, veri alma, gönderme, güncelleme ve silme için uç noktaları test edeceğiz.

JavaScript ile Get API Endpoint Nasıl Test Edilir

Üretimde kullanacağınız gibi, JavaScript'te bir API'yi Axios veya getirme yöntemini kullanarak test edebilirsiniz .

fetch kullanarak API'den yanıt durumunu almak için :

fetch('https://fakestoreapi.com/products', ).then(res =>{ console.log(res) })

Yukarıdaki istek, geçerli bir yanıtsa 200 durumunu döndürür. Başarılı bir istekte bulunduktan sonra API'den gerçek zamanlı veriler talep edebilirsiniz.

Bu API'den verileri alalım:

fetch('https://fakestoreapi.com/products', ).then(res =>{ if (res.ok){ return res.json() } }).then(response=>{ console.log(response) }).catch(err => console.log(err))

Yukarıdaki getirme koduna verilen yanıt şöyle görünür:

Örneğin tüm ürünlerin fiyatını almak için harita işlevini kullanabilirsiniz :

fetch('https://fakestoreapi.com/products', ).then(res =>{ if (res.ok){ return res.json() } }).then(response=>{ response.map(data =>{ console.log(data.price) }) // console.log(response) }).catch(err => console.log(err))

Yukarıdakiler aşağıdaki çıktıyı günlüğe kaydeder:

Python ile Get Endpoint'i Test Etme

Daha önce belirtildiği gibi Python, bir API'nin verilerine erişmek için istek kitaplığını da kullanır .

Bu durumda yanıtın durumunu kontrol etmek için:

import requests data = requests.get('https://fakestoreapi.com/products') print(data.status_code)

Yukarıda yaptığımız gibi günlüğe kaydetme verileri karşılık gelen bir durumu döndürür. Yine de bu durumda 200.

Şimdi JavaScript'i kullanırken yaptığımız gibi Python ile aynı verileri alalım:

import requests data = requests.get('https://fakestoreapi.com/products') myData = data.json() print(myData)

Yukarıdakilerin sonucu şöyle görünür:

for döngüsünü kullanarak belirli verileri alabilirsiniz .

Örneğin ürün fiyatlarını almak için:

import requests data = requests.get('https://fakestoreapi.com/products') myData = data.json() indexes = 0 for i in myData: goods = myData[indexes] indexes +=1 print(goods["price"])

Çıktı şöyle görünür:

JavaScript ile Bir Gönderi Bitiş Noktasını Test Etme

Test ettikten ve Alma isteğinin çalıştığını gördükten sonra , amacınıza ve API'nin sunduklarına bağlı olarak, buna da veri ekleyip ekleyemeyeceğinizi kontrol etmek isteyebilirsiniz.

Alma isteğinde bulunma şeklinizin aksine , Gönderme isteği bir yükü kabul eder. Ayrıca, bunun bir Gönderi isteği olduğunu belirtmeniz gerekir:

// Specify the payload let payload = { title: 'new product', price: 13.5, description: 'test description', image: '', category: 'electronic' } fetch('https://fakestoreapi.com/products', { method: "Post", headers:{ 'Content-Type': 'application/json' }, body: JSON.stringify(payload) //convert the payload to JSON } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

Yukarıdaki kod, yanıt durum kodunu ve çalıştırdığınızda girilen yeni bilgileri günlüğe kaydeder. Bu, isteğinizin gerçekleşip gerçekleşmediğini size söyler. Tipik olarak, durum kodu 200 ise API'nizin uygun yanıtı döndüren geçerli bir uç noktası vardır.

Python ile Gönderi İsteğini Test Etme

Ayrıca Python'un kullanarak bir API sonrası uç noktasını test edebilirsiniz requests.post . JavaScript'in fetch işlevini kullanırken yaptığınız gibi , yükü burada da belirtmeniz gerekir:

import requests payload = { 'title': 'new product', 'price': 13.5, 'description': 'test description', 'image': '', 'category': 'electronic' } Posted = requests.post('https://fakestoreapi.com/products', data = payload ) print(Posted.status_code) print(Posted.json())

JavaScript gibi, yukarıdaki Python kodu da yanıt durum kodunu ve payload içinde belirtilen yeni verileri günlüğe kaydeder .

Put Uç Noktalarını Test Etme

API verilerini güncellemek, yayınlamak ve bunları her iki dilde almakla aynı süreci alır.

Bunu JavaScript'in getirme özelliğini kullanarak yapmak için , yalnızca Post ile Put'u değiştirmeniz gerekir :

// Specify the payload let payload = { title: 'new product', price: 13.5, description: 'test description', image: '', category: 'electronic' } fetch('https://fakestoreapi.com/products/19', { method: "Put", headers:{ 'Content-Type': 'application/json' }, body: JSON.stringify(payload) //convert the payload into JSON } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

API uç noktasına dikkat ederseniz, bu sefer ürün kimliğini içerdiğini göreceksiniz. API, bu durumda hangi verileri güncellemek istediğinizi bu şekilde bilir.

Bununla birlikte, bazı API'ler, uç noktalarını oluşturmak için başka yöntemler kullanabilir. Yani bu bir standart değil.

API veri güncellemesini Python kullanarak test etmek için bunun yerine request.put'u kullanırsınız:

import requests payload = { 'title': 'new product', 'price': 13.5, 'description': 'test description', 'image': '', 'category': 'electronic' } Posted = requests.put('https://fakestoreapi.com/products/19', data = payload ) print(Posted.status_code) print(Posted.json())

Yukarıdaki örnekler başarılı olursa, yeni verileri API bitiş noktası tarafından belirtildiği gibi 19 konumuna ekleyin.

Silme İsteğini Test Etme

Bir API'den veri silmek, Alma isteği yapmak kadar kolaydır. Bunun nedeni, Post and Put'tan farklı olarak herhangi bir yük belirtmeniz gerekmemesidir. Tek ihtiyacınız olan silme bitiş noktasıdır.

Burada seçtiğimiz API, verilerini izlemek için ürün kimliğini kullanır. Bu nedenle, bir ürünü silmek kolaydır:

fetch('https://fakestoreapi.com/products/19', { method: "Delete", headers:{ 'Content-Type': 'application/json' } } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

Python kullanarak aynı şeyi elde etmek için sadece birkaç satır koda ihtiyacınız var:

import requests Posted = requests.delete('https://fakestoreapi.com/products/19', ) print(Posted.status_code) print(Posted.json())

Yukarıdaki her iki örnek de yanıt durum kodunu ve sorgulanan kimliğe (bu durumda 19) ait verileri günlüğe kaydeder.

Bu Test Yöntemleri Genel mi?

Bu gönderide yalnızca tek bir API'ye odaklanmış olsak da, CRUD uç noktalarını test etmek için kullanılan yöntemler, diğer API'lerle çalışırken farklı değildir. Tabii ki tek fark, her bir API yapısını çevreleyen kurallarda ve veri isteme yönergelerinde olabilir. Bunları seçilen bir API için deşifre ettiğinizde, ilgili uç noktalarını test etmek için burada açıklandığı gibi uygun yöntemi kullanabilirsiniz.

Bu nedenle, her API'nin kendisine bağlanmak için kuralları olduğundan, test sırasında bazıları istek başlıklarınıza eklemeniz için ek parametreler sağlayabilir. Bu tür parametreler genellikle bir erişim belirtecini veya belgelerde sağlanan diğerlerini içerir.