Postman ve API'e İlk Bakış (Application Programming Interface)
Postman, API (Application Programming Interface) testleri yapmak, geliştirmek ve belgelemek için kullanılan popüler bir platformdur.
Eğer postman’e yeni başlamak istiyorsanız ve temel olarak terimlere ve koleksiyon oluşturmaya aşina olmak istiyorsanız blog yazımızı okumaya devam edebilirsiniz .
Öncelikle bilmemiz gereken ilk terim API olacaktır. API nedir diye basitçe anlatmak gerekirse API'lar, yazılım uygulamalarının birbiriyle iletişim kurmasını sağlayan arayüzlerdir. Veri alışverişi yapmak ve işlevsellik sağlamak için kullanılırlar.
Postman nedir?
Postman, API'larla çalışmayı kolaylaştıran bir geliştirici aracıdır. API istekleri oluşturabilir, gönderebilir, yanıtları inceleyebilir ve hata ayıklama yapabilirsiniz. Postmanin temel olarak ne olduğunu açıkladıktan sonra , şimdi postmani daha iyi anlamanız ve efektif kullanabilmeniz için bilmeniz gereken bazı parametreler var, bunları tek tek açıklayarak postmanle alakalı bilgilerimizi daha da pekiştireceğiz.
Request (İstek):
Bir API'ye belirli bir amacı gerçekleştirmesi için yapılan talepler. İstekler, sunucuya veri gönderme, veri alma veya işlem yapma gibi amaçları taşıyabilir. Bir istek genellikle aşağıdaki bileşenleri içerir.
HTTP Metodu:
İsteğin amacını belirten HTTP metodu, örneğin GET, POST, PUT veya DELETE.
URL (Uniform Resource Locator):
İstek yapılacak kaynağın belirlediği adres.
Query Parametreleri:
İstekle birlikte gönderilen ek veriler. URL'in sonuna "?key=value" şeklinde eklenir.
Gövde (Body):
POST veya PUT gibi metotlarda gönderilen veridir.
Başlıklar (Headers):
İsteğin ek bilgilerini içeren başlık alanları.
Response (Yanıt):
Bir API isteğine verilen cevaplar. Yanıtlar, sunucudan gelen bilgileri ve isteğin durumunu içerir.
Bir yanıt genellikle aşağıdaki bileşenleri içerir:
Durum Kodu (Status Code):
Sunucunun isteğe verdiği yanıtın genel durumunu belirten üç haneli kod.
Başlıklar (Headers):
Yanıtın ek bilgilerini içeren başlık alanları.
Yanıt Gövdesi (Response Body):
Sunucudan dönen veri veya içerik.
HTTP Metodları:
GET
Bir kaynağın okunması için kullanılır. Veri istenir, ancak sunucu veriyi değiştirmez.
POST
Sunucuya yeni veri eklemek veya işlem yapmak için kullanılır.
PUT
Varolan bir kaynağı güncellemek için kullanılır. Eğer kaynak yoksa, yeni bir kaynak oluşturabilir.
DELETE
Bir kaynağı silmek için kullanılır.
Parametreler:
Query Parametreleri:
URL içinde belirtilen, genellikle anahtar-değer çiftleri olan veriler.
Path Parametreleri:
URL içinde yolu belirlemek için kullanılan veriler. Örneğin: products/{category}} (category burada bir path parametresidir)
Gövde Parametreleri: POST veya PUT isteklerinde gönderilen veriler. JSON veya form verisi şeklinde olabilir.
Headers (Başlıklar):
HTTP istek ve yanıtlarının ek bilgilerini içeren alanlardır. Örneğin, isteğin veya yanıtın içeriğini tanımlayan "Content-Type" başlığı.
Authorization (Yetkilendirme):
API'ye erişim yetkisi sağlamak için kullanılır. Yetkilendirme başlığı (Authorization Header) içinde, genellikle token veya API anahtarı bulunur.
Environment (Ortam):
Farklı sunucular veya yapılandırmalar için kullanılan değişkenleri ve değerleri saklamak için kullanılan bir özellikler. Bu, farklı ortamlarda çalışırken tekrar tekrar aynı değerleri girmek zorunda kalmamanızı sağlar.
Collection (Koleksiyon):
İlgili API isteklerini ve belgeleri gruplandırmak için kullanılan bir yapıdır. İstekler,aynı projenin farklı parçalarını temsil eden koleksiyonlar içinde organize edilir. Postmani temel olarak sizlere açıkladıktan sonra , postmande bir koleksiyon oluşturmanızı ve daha sonra bunu nasıl test edebileceğinizi anlatacağız. Örneğin postmande bir e-ticaret sitesi için koleksiyon oluşturmak isyiyorsunuz diyelim bunun için uygulamanız gereken adımlar şu şekilde olmalıdır.
Postman Uygulamasını Açın: Postman uygulamasını başlatın ve ana arayüzü görüntüleyin.
Koleksiyon Oluştur: Sol üst köşede yer alan "Collections" bölümüne tıklayın.
- Açılan menüde "New Collection" (Yeni Koleksiyon) düğmesine tıklayın.
- Koleksiyonun adını girin, örneğin "E-Ticaret API Testleri".
- İsteğe bağlı olarak açıklama ekleyebilirsiniz. İstekleri Koleksiyona Ekleyin:
- Oluşturduğunuz koleksiyona tıkladığınızda, koleksiyonun içine istekler eklemek için "Add a request" (İstek Ekle) düğmesine tıklayın.
- Açılan pencerede isteğiniz için bir ad belirleyin, örneğin "Ürünleri Listele".
- İstediğiniz HTTP metodunu seçin, örneğin "GET". - URL bölümüne API'nin URL'sini girin, örneğin "https://example.com/api/products".
- Gerekirse query parametreleri veya istek ayarlarını ekleyebilirsiniz.
İstek Ayarlarını Özelleştirin: İstek oluşturduktan sonra Headers (Başlıklar) bölümüne giderek isteğe başlık ekleyebilirsiniz.
Örneğin, Authorization başlığı için bir API anahtarı ekleyebilirsiniz. Eğer istek gövdesi gerekiyorsa, Body (Gövde) bölümünden gövde parametrelerini ekleyebilirsiniz.
İsteği Gönderin ve Yanıtı İnceleyin: İstek oluşturduktan sonra "Send" (Gönder) düğmesine tıklayarak isteği sunucuya gönderin.
Yanıtı Headers ve Response Body bölümlerinden inceleyebilirsiniz. Koleksiyonu Kaydedin: İstekleri ekledikten ve özelleştirdikten sonra, koleksiyonu kaydetmeyi unutmayın.
Koleksiyonun üst kısmındaki "Save" (Kaydet) düğmesini kullanabilirsiniz. Bu adımları izleyerek, Postman'da bir e-ticaret sitesi için API testleri yapmak üzere bir koleksiyon oluşturabilirsiniz. Koleksiyon içine farklı istekleri ekleyerek, API'nin farklı özelliklerini ve işlevlerini test edebilirsiniz. Koleksiyonumuzu hazırladıktan sonra, Postman ile oluşturduğumuz koleksiyonu nasıl test edeceğimize gelecek olursak;
Koleksiyonu Seçin: Sol üst köşede bulunan "Collections" bölümüne tıklayarak e-ticaret koleksiyonunu seçin.
İstek Seçin: Koleksiyon içindeki isteklerden test etmek istediğinizi seçin. Örneğin, "Ürünleri Listele" isteğini seçelim.
Gerekirse Parametreleri Ayarlayın: İstek için gerekli parametreleri veya gövde parametrelerini ayarlayın.
Örneğin, query parametreleri ekleyebilirsiniz. Başlıkları ve Yetkilendirmeyi Ayarlayın: İsteğin başlıklarını ayarlayın. Eğer yetkilendirme gerekiyorsa, Authorization başlığını ekleyin ve gerekli kimlik doğrulama bilgilerini girin. Gönderin ve Yanıtı İnceleyin: "Send" düğmesine tıklayarak isteği sunucuya gönderin. Sonuçları "Response" sekmesinde inceleyebilirsiniz.
Diğer İstekleri Test Edin: Diğer istekleri de aynı şekilde sırayla seçin, parametreleri ayarlayın, başlıkları ve yetkilendirmeyi yapılandırın, isteği gönderin ve yanıtları inceleyin.
Bu basit adımları takip ederek, oluşturduğunuz e-ticaret koleksiyonunu Postman'da test edebilirsiniz.
Bog yazımızda Postman ile alakalı temel bilgilerinize ve basic olarak Postman'de oluşturduğunuz kendi koleksiyonunuzu nasıl test edebileceğinizde hakkında katkı sağlamak amaçlanmıştır. Detaylı bilgi için bizimle her zaman iletişime geçebilirsiniz.
Yazar: Nazlı Akbaytürk
