Postman Script Yazimi
Merhaba 🙋✨
Bu yazımda benim de Api testlerini yaparken severek kullandığım , son derece kullanıcı dostu arayüzlü, Postman aracı ile birlikte api testlerimizi yapalım.
Testleri yazarken postmanin test script arayüzünü ve Trello’nun apilerini kullanacağım. https://developers.trello.com/reference
Haydi Başlayalım
Ortam
Postman birçok yazılımcı ve test uzmanın kullandığı apileri paylaşmak,test etmek ve monitor etmek üzere kullanılan bir clienttır. Apilerinizi arayüzünün rahatlığı sayesinde kolay ve hızlı bir şekilde test edebilirsiniz. Aynı zamanda sorgularınızı kaydederek rahat bir api dokumantasyon sistemi oluşturabilirsiniz. Postman bizlere testlerimizi yazarken kolay bir snippet arayüzü sağlıyor. Biz de bunları kullanarak test scriptlerimizi aşağıdaki gibi rahatca yazabileceğiz.
Okulda veya işyerinde işlerimizin takibini yaparken mutlaka Trello kullanıp yeni bir Board açmış ve taskları bu sanal boardta durumuna göre (to do,done,..)güncellemişizdir. İsterseniz şimdi bu board yapısına farklı bir gözle bakalım. Trello Developers adresine giderek apilerimizi kurcalayalım.
Biz yeni bir board oluşturarak içerisine todo ve done diye listeler oluşturacağız.Sonra ise To-do alanına yeni bir card ekleyerek bunu todo alanından done alanına sürükleyeceğiz. İşimiz bittikten sonra ise de board’umuzu sileceğiz.
- Postman Collection Oluşturma
İlk olarak Postman’i açıp new collection diyerek yeni bir collection oluşturalım.
2.Request oluşturma
Board Oluşturma
TrelloBoard adlı collection’ımızı oluşturduktan sonra şimdi ise yeni Board Oluşturalım. Bunun için https://developers.trello.com/reference#boardsid adresine giderek bir post requesti oluşturalım.
Şekildeki gibi parametreler tanımlayarak board’un adını , trello developers alanından( https://trello.com/app-key adresinden oluşturmanız gerekmekte) aldığımız api key ve token’ımızı belirletelim.
Şimdi ise tests kısmına gidelim ve Snippetslerimizin rahatlığıyla birlikte boardumuzu oluşturmak için scriptlerimizi yazalım.
Postman script alanı javasript dili ile yazılıyor. Burada scriptleri yazarken Snippets’lerden de Postman’in dokumantasyonu olan https://learning.getpostman.com/docs/postman/scripts/intro-to-scripts/ adresinden de faydalanabilirsiniz. İkisi de oldukça faydalı:)
Create Board Scripttinde status code’un 200 olmasına bakarak post requestimizin başarılı olma durumunu kontrol ettiriyoruz. JSonData adlı bir değişken tanımlayarak response’daki json modelini buna eşitliyoruz. Ve dataki name kısmının “sevilay medium Board”(isimlendirmesini başka da yapabilirsiniz)olarak oluşup oluşmadığını kontrol ettiriyoruz. Son olarak da board’umuzun private olarak oluştuğunu kontrol ettiriyoruz.
Scriptlerimizi de yazdıktan sonra şimdi sıra geldi çalıştırmaya. Board oluşturma requestimizi çalıştırdığımızda aşağıdaki gibi resultlar bize dönecektir.
Todo-List Oluşturma
Boardımızı oluşturduğumuza göre şimdi de bordumuza bir todo list oluşturalım. Bunun için oluşturdumuz board idsi ile birlikte aşağıdaki gibi bir Post requesti gönderelim.
Test Scriptinde ise de status durumunun başarılı olmasına, listenin adının TODO olmasına ve closed durumunun da false ‘a eşit olmasını kontrol ediyoruz. Daha önce oluşturduğumuz Board’un id’sini de kontrol ederek todo listemizi o id’ye sahip Board altına açıyoruz.
Şimdi scriptimizi çalıştırarak todo listemizi oluşturalım. Sonuçları görüntüleyelim.
Todo listemizi de oluşturduğumuza göre şimdi de bir done listesi oluşturalım.
Done-List Oluşturma
Burada da oluşturduğumuz yapı to-do listesiyle neredeyse birebir aynı. Fakat name kısmında değişiklik olacaktır.
Şimdi çalıştırıp sonuçlarını görüntüleyelim.
Harika! todo ve done listlerimiz de hazır şimdi todo listemize bir card ekleyelim ve bunu todo’dan done’a sürükleyelim.
Card Oluşturma
Sıra ile gidecek olursak önce Todo Listemize ismi “lp” olan bir card ekleyelim.
Burada id list olarak tanımlayacağımız değişken , todo listesinin altına ekleyeceğimizden dolayı, önceden oluşturduğumuz todo listesinin id’si olmalı.
Script kısmına gelelim. Id durumlarını ve card’ın ek bulundurma durumları nı kontrol edelim.
Şimdi requestimizi gönderelim ve sonuçlarını görüntüleyelim.
Card’ı todo-dan done ‘a çekme
Bu işlemi de hallettikten sonra sıra geldi card’ımızı yani taskımızı todo’dan done’a çekmeye. Update işlemi olduğu için bir put requesti oluşturacağız.Ve burada taskımızı todo alanında done’a getireceğimiz için id alanına Todo listesinde oluşturduğumuz idyi, id Listemize de done listemiz sonucunda oluşan id bilgisini gireceğiz.
Şimdi sonuçlarımızı görüntüleyelim.
Board’umuzu güzelce oluşturup içine todo , done listeleri ve card ekleyip işlemlerimizi gerçekleştirdik. Şimdi oluşturduğumuz Boardu silelim.
Board’u Silme
Bunun için bir delete requesti oluşturarak parametrelerimizde boardidyi token ve key’’imizi göndermek yeterli olacaktır.
Test Scriptimizde ise status coduna bakalım. 200 başarılı olma durumunu kontrol edelim.
Test Sonuçlarını da kontrol ettiğimizde testimiz başarıyla geçtiğini görüyoruz.
Son olarak bu Board id’yi bir get requesti ile çağıralım ve silinmiş olduğunu görüntülenemediğini görelim.
Silinen Board’u görüntüleme
Bu aşamada Bir get requesti ile birlikte daha önce silmiş olduğumuz board’un gelmediğini ve sonucunda 404 hata kodu aldığımızı teyit edeceğiz.
Görüldüğü gibi board’umuz gelmedi ve 404 hata kodunu teyit ettiğimiz için bize sonucunu başaralı döndü.
3.Collection’u Run Etme
Son olarak tüm requestlerimizi çalıştıralım.Ve sonuçlarını görüntüleyelim.
Bunun için collection’u seçip run alanına tıklamamız yeterlidir.
Tüm requestlerimiz başarılı 😍 Bu yazımda postman’de bir api testinin nasıl yapılacağını anlatmaya çalıştım. Bir sonraki yazılarımızda görüşmek dileğiyle ♥️
