Detaylı Postman Kullanım Rehberi
API lerinizi kapsamlı şekilde test edin
Herkese Merhabalar Bir Rest API test aracı olan Postman ‘i detaylıca anlatmak için bu makaleyi yazmaya karar verdim. Baştan sona, Uçtan uca Çok kapsamlı bir yazı olacak. Hemen Aşağıda Yazı içeresinde anlatacağım section lara ulaşabilir, tıklayarak direkt olarak yazının o kısmına ulaşabilirsiniz, şimdiden iyi okumalar.
Makale içeriği :
Postman Nedir ?
Postman, Projenizde yarattığınız Rest API leri test etmeniz için Postman Inc. tarafından geliştirilmiş Açık Kaynak kodlu bir API test aracıdır.
Bir Endpoint ‘in Frontend client leri tarafından implemente edilmesinden önce geliştirici tarafından endpoint’ in kullanımını kavrayabilir, hangi durumda nasıl tepki alacağını görebilir böylelikle implemente süreci çok kısalır. Postman de neler yapılabilir sorusunun cevabı aslında çok geniştir biraz başlıklarla bahsetmek gerekirse ;
Oluşturulan request objelerini ya da Direkt Collection ‘ları export edip Ekibiniz ile paylaşabiliyorsunuz.
Request Objeleri arası veri aktarabiliyorsunuz,
Pre — Request Scriptler ile spesifik özelliklere sahip Request ler oluşturabiliyorsunuz,
Global ve Environment Variable Seçenekleri ile veri tekrarının önüne geçilebilir.
Mock Servers kurulumu ile sunucu bazlı çalıştırabilir,
Monitor özelliği ile bütün metrikleri inceleyebilir ve daha bir çok özelliğe sahip, alanında lider bir araçtır.
Postman Aracını web.postman.com üzerinden kullanabileceğiz gibi aynı zamanda https://www.postman.com/downloads/ adresinden cihazınıza kurup, kullanabilirsiniz.
Postman ‘de Request Objesi Hazırlamak
Aşağıda ki görselde ki arayüzü biraz inceleyip, yabancılık hissini kıralım, ardından ilk Request objesini oluşturalım.
Benim Collection larım sizde elbette olmayacak, o kısıma dikkat etmeyin lütfen
Ilk Request ‘imizi oluşturalım
Import butonu yanında gördüğünüz, “ + “ butonuna basarak ya da new butonuna basarak oluşturabileceğiniz gibi, windows ‘ta ctrl + t ; Mac cihazlarda Command + t kısayolu ile ilk request i oluşturabilirsiniz.
Şimdi Örnek olması için kendi Rest API sunucuma istek atacağım,
Görüldüğü üzere endpoint ve gerekli parametreleri gerekli alanlara girdikten sonra “BASİT” düzeyde bir request oluşturabilir ve API nizi test edebilirsiniz. Biraz inceleyecek olursak, localhost/home/getTestDummyData adresine, pageable parametreleriyle istek attıktan sonra response objesini aşağıda görebiliyoruz.
Http Status, Response Time , Response Size kısımlarını da elde edebilir, analiz için kullanabilirsiniz
Biraz Vites Yükseltelim
Request Objesine bir de Authorization bilgisi katmamız gerektiği durumlarda, ya da header da talep edilen herhangi bir bilgiyi, Request Objesinin Header kısmına girebilirsiniz, Aşağıda örnek görsel üzerinden Yapalım.
Bu Noktada Artık Basit Düzeyde istek atıp , Response Objesimizi elde Edebildik.
Postman Collection Yapısı
Request objemizi 1 kez kullanıp uygulamayı kapattığınızda artık oluşturulan Obje yok olacaktır. Ama o istekleri her an kullanman gerekebilir , o yüzden “ Klasörleyerek “ saklamamız gerekebilir.
Test Collection oluşturdum, ve içine az önce ki örnek de kullandıgım Request Objesini attım, Bir başka Request oluşturacak olsam, yine içine koyabilir, ya da collection içine “Ayrı” klasörleme yapısı kurabilirim. aynen şu şekilde.
örnekte ki gibi, düzenli çalışma neticesinde her isteğe hızlıca ulaşabilir , duplicate yapıdan kaçınmış olursunuz.
Postman’ de Global ve Environment Variable Tanımlanması
Veri Tekrarının önüne geçilmesi hususunda çok önemli bir konudur.
Örnek Senaryo :
200 tane Request objesinin localhost:80 adresine istek attığını varsayalım, ve 200 tanesinin de header sekmesinde Authorization sekmesinin Hard Code / Magic String olarak yazıldığını varsayalım.
Muhtemel Problem :
bir gün localhost:8080 adresi olarak değiştirmeniz gerekirse, 200 objeyi tek tek değiştirmek zorunda kalacaksınız. aynı şekil Bearer token ‘in Son Geçerlilik Tarihi sona erdiği zaman, yine 200 Objeden Değiştirmek zorunda kalacaksınız.
İşte Bunun için localhost:80 ve Bearer token bilgilerini bir değişkene tanımlayıp , Request Objelerinde o değişken adını kullanalım.
bunun için öncelikle sol panelde ki , Environments sekmesine girelim
Test Environments For medium adında bir scope da değişkenlerimi yan tarafta tanımladım. Artık Request Objelerimde kullanabilirim.
Artık hiçbir veri tekrarına geçit yok ! istersem tek noktadan url de değiştiririm, istersem Bearer token değerini de değiştiririm. Asla Request Objeme müdahale etmeme gerek kalmadı.
Önemli Not : Doğru Environment da olduğunuza dikkat edin , yoksa değişkenleri tanıyamaz.
sağ köşede görüldüğü üzere hangi scope da olacaksam onu seçiyorum.
Postman Pre-Request Script sekmesi
Nedir bu Pre Request Sekmesi diyecek olursanız, Request Objesinin Send İşleminden hemen önce Execute edilen komutları yazdığımız kısımdır, Mesela aşağıda ki örnekte Date Set eden bir script göreceğiz.
Yan tarafta ki snippet leri inceleyecek olursanız, hazır bazı kodlar görebiliriz.
Buradan bir çok hazır koda erişim mümkün.
Runner ile Request Testing
Runner, Postmanin alt sekmesinde bulabileceğiniz, Seçtiğiniz Endpoint leri , istediğiniz kadar , istediğiniz aralıklarla çalışmasını ve Testlerini execute eden bir modüldür. böylelikle, koca bir collection içerisinde ki tüm endpointleri tek bir tuş ile çalıştırabilirsiniz.
Buradan istediğiniz endpoint’ leri ya da direkt collection’ ı Sürekle & Bırak yaparak Run Order sekmesine taşıyoruz, sağ panelde Iteration kaç kere çalışacağı, Delay ise kaç saniye aralık ile çalışacağı ayarıdır. Ardından Run Test Collection For Medium butonuna basarak (Sizde ki collection Adı buton adı olacaktır.) çalıştırabilirsiniz.
istek üzerine tıklayarak detayları görebilirsiniz. (Save Responses Seçili olmalıdır.)
Postman Console
Postman de çalışacak her türlü Javascript kodunu yazabileceğiniz bir console ile birlikte gelir. Ayrıca buradan Attığınız Request ler de loglanır.
İstersek Javascript kodu da yazabiliyorduk,
Workspace Ortak Çalışma alanları
Bazen Postman de hazırladığınız Collection ları başka ekip arkadaşlarınız ile paylaşmak isteyebilir, başkalarının isteklerini görmek isteyebilir, veya başka bir sebebten dolayı ortak bir çalışma alanına ihtiyaç duyabilirsiniz. Bu noktada postman workspace ‘ den faydalanabilirsiniz. Bunu için yapmanız gereken önce postman’ e giriş yapmak (Hesabınız yoksa register olmak), ardından bir workspace oluşturmak.
https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/ Burada ki adresten Personal , Private , Team ve benzeri opsiyonlarda Workspace yaratabilir, Ekibinizi invite edebilirsiniz.
Collection Export / Import Etmek
Bir Workspace oluşturmadan, hazırladığınız Collection’ ları paylaşabilir, ya da teslim alabilirsiniz. Bunun için Collection ‘ ı export / import etmek yeterli olacaktır.
Burada ki export a basarak, açılan pop up ekranda ki
Export a basarak, JSON formatında Collection ‘ ı export edebilirsiniz,
Eğer Teslim aldığınızı varsayacak olursak
Buradan import a basarak, Açılan pop up ekranından
Export Edilmiş Json dosyasını buraya Drag & Drop ya da upload files yaparak bütün collection ı çalışma alanınıza dahil edebilirsiniz.
Buraya kadar okuduğunuz için, teşekkür ederim. Postman ve çoğu özelliğini elimden geldiği sürece izah etmeye çalıştım. Umarım aradığınız bilgiyi size sağlamıştır. Başka bir yazıda görüşmek üzere…
Destek olmak için Github Adresimi ve Linkedin Profilimi ziyaret edebilirsiniz.
Şimdiden Teşekkürler, iyi çalışmalar.
