Yeni API'niz için güzel, kapsamlı bir OpenAPI spesifikasyonu tasarlamayı yeni bitirdiniz. Her bir uç noktayı, parametreyi ve yanıtı belgeliyor. Bu bir sanat eseri. Ama şimdi zorlu kısım geliyor: Hepsini test etmeniz gerekiyor. Düzinelerce uç nokta için manuel olarak test senaryoları oluşturmak, sıfırdan başlamak gibi hissettiriyor. Spesifikasyonunuzdaki yolları tek tek bir test aracına kopyalarken buluyorsunuz kendinizi ve daha iyi bir yol olup olmadığını merak ediyorsunuz.
Tek doğruluk kaynağınız olan o OpenAPI spesifikasyonunu, sadece birkaç tıklamayla eksiksiz, çalıştırmaya hazır bir test paketine dönüştürebilseydiniz ne olurdu? Sıkıcı manuel kurulumu atlayıp doğrudan API'nizin tasarlandığı gibi çalıştığını doğrulamaya geçebilseydiniz ne olurdu?
Bu bir varsayım değil. Doğru araçla, bu sürecin tamamını otomatikleştirebilirsiniz. Apidog, API tasarımı ile API testi arasındaki boşluğu sorunsuz bir şekilde kapatmak için tasarlanmıştır. Güçlü içe aktarma ve yapay zeka özellikleri, statik OpenAPI belgenizi dakikalar içinde dinamik, yaşayan bir test paketine dönüştürebilir.
Şimdi, Apidog kullanarak kapsamlı API test koleksiyonlarını doğrudan OpenAPI spesifikasyonlarınızdan oluşturmanın tam, adım adım sürecini inceleyelim.
Adım Adım Kılavuz: OpenAPI Spesifikasyonundan Apidog'da Test Koleksiyonuna
Adım 1: OpenAPI Spesifikasyonlarınızı Apidog'a Aktarın
Sürecin temeli, API tasarımınızı Apidog'a aktarmaktır. Bu, manuel bir yeniden oluşturma değil, basit bir içe aktarmadır.
Nasıl yapılır:
- Apidog projenizde, **Ayarlar**'a gidin veya **"İçe Aktar"** seçeneğini arayın.
2. Apidog birden fazla içe aktarma yöntemini destekler:
- Doğrudan Dosya Yükleme:
openapi.yamlveyaopenapi.jsondosyanızı sürükleyip bırakın. - URL İçe Aktarma: Ham OpenAPI spesifikasyonunuzun barındırıldığı bir URL sağlayın (örn. GitHub'daki spesifikasyonunuza veya dahili dokümantasyon portalınıza bir bağlantı).
- Manuel Giriş: Ham JSON/YAML içeriğini doğrudan da yapıştırabilirsiniz.
3. Apidog spesifikasyonu ayrıştıracak ve anında arayüzünde eksiksiz bir API proje yapısı oluşturacaktır. Tüm uç noktalarınızın, yöntemleri, parametreleri ve istek/yanıt modelleri önceden doldurulmuş olarak düzenlendiğini göreceksiniz.
Bunun size sağladığı: Anında, API'nizin Apidog içinde tam olarak gezilebilir, etkileşimli bir temsiline sahip olursunuz. Herhangi bir uç noktaya tıklayabilir ve ayrıntılarını görebilirsiniz. Bu, statik bir belgeden zaten çok daha ileride, ama daha yeni başlıyoruz.
Adım 2: Apidog'un API Testlerini Nasıl Yapılandırdığını Anlayın
Test koleksiyonları oluşturmadan önce, Apidog'un test etme konusunda nasıl düşündüğünü anlamak faydalı olacaktır.
Apidog'da:
- Her API uç noktası birden fazla test senaryosu içerebilir
- Test senaryoları test koleksiyonlarına aittir
- Test koleksiyonları mantıksal olarak düzenlenebilir (modül, özellik veya hizmete göre)
Her şey OpenAPI spesifikasyonundan türetildiği için, tek bir test yazmadan önce bile yapı zaten mantıklıdır.
Adım 3: Yapay Zeka Kullanarak API Test Koleksiyonları Oluşturun
İşte sihrin gerçekleştiği yer burası. API yapınız Apidog içinde yaşamaya başladığında, kapsamlı bir test paketi oluşturmasını ona emredebilirsiniz.
Nasıl yapılır:
- Herhangi bir uç nokta dokümantasyon sayfasında **"Test Senaryoları"** bölümüne gidin.
- **"Yapay Zeka ile Oluştur"**'a tıklayın. Apidog, mevcut testi olmayan bir API'niz olduğunda bunu genellikle belirgin bir düğme olarak gösterir.
3. Apidog'un yapay zekası, içe aktardığınız tüm uç nokta yapısını analiz edecektir. Sadece her uç nokta için bir test oluşturmaz. Bir test uzmanı gibi düşünür:
- Başarılı Akış Testleri: Başarılı işlemler için testler oluşturacaktır (örn.
GET /users/1,200 OKdöndürür). - Hata Durumu Testleri: Spesifikasyonunuzda tanımlanan hata durumları için otomatik olarak testler oluşturur; örneğin,
400 Bad Request'i tetiklemek için geçersiz veri göndermek veya401 Unauthorizeduç noktası için kimlik doğrulama hatasını test etmek gibi. - Parametre Doğrulama: OpenAPI şemanızda tanımladığınız zorunlu alanları, enum değerlerini ve veri tipi kısıtlamalarını test etmek için senaryolar oluşturacaktır.
- Uç Durumlar: Yaygın test modellerine dayanarak, boş listeler, sayfalama limitleri veya alışılmadık giriş kombinasyonları için testler önerebilir.
4. Yapay zeka size önerilen bir test senaryoları listesi sunar. Bunları inceleyebilir, adlarını düzenleyebilir ve tek bir tıklamayla koleksiyonunuza hangilerini ekleyeceğinizi seçebilirsiniz.
Bunun size sağladığı: Bir dakikadan kısa sürede, sıfırdan pozitif akışları, negatif akışları ve doğrulama mantığını kapsayan sağlam bir test koleksiyonuna sahip olursunuz. Oluşturulan her test senaryosu, Apidog içinde tamamen yapılandırılmış, çalıştırılmaya hazır bir istektir.
Adım 4: Oluşturulan Test Koleksiyonlarını İnceleyin ve Özelleştirin
Yapay zeka ağır işlerin çoğunu yapsa da, Apidog size yine de tam kontrol sağlar.
Test koleksiyonları oluşturulduktan sonra şunları yapabilirsiniz:
- İstek parametrelerini inceleyin
- Test verilerini ayarlayın
- Doğrulamalar ekleyin
- Test senaryolarını yeniden adlandırın
- Koleksiyonları mantıksal olarak düzenleyin
İşte **otomasyon + manuel iyileştirme**'nin bu birleşimi, Apidog'u gerçek projeler için pratik kılan şeydir.
Adım 5: API Testlerini OpenAPI Spesifikasyonlarıyla Senkronize Tutun
API testinde en büyük zorluklardan biri **sapma**dır.
API'ler gelişir.
Şemalar değişir.
Testler geride kalır.
Apidog test koleksiyonlarını doğrudan OpenAPI spesifikasyonlarına bağladığı için güncellemeleri yönetmek çok daha kolaydır.
Spesifikasyon değiştiğinde:
- Test senaryolarını yeniden oluşturabilirsiniz
- Etkilenen uç noktaları güncelleyin
- API ve testler arasındaki uyumu koruyun
Bu, bakım maliyetini önemli ölçüde azaltır.
Bu API Test Koleksiyonları Nasıl Görünüyor?
Bunu somutlaştıralım. Bir Kullanıcı API'si için basit bir OpenAPI spesifikasyonu içe aktardığınızı hayal edin:
GET /usersPOST /usersGET /users/{id}PUT /users/{id}
Apidog'un yapay zekası sadece dört test oluşturmaz. Şuna benzer bir test koleksiyonu oluşturabilir:
Koleksiyon: Kullanıcı API Doğrulaması
Test: Tüm kullanıcıları getir - Başarılı
GET /users'ın bir dizi ile 200 OK döndürdüğünü kontrol eder.
Test: Kullanıcı oluştur - Başarılı
Spesifikasyonunuzdaki örnek verilerle geçerli bir POST /users isteği gönderir ve 201 Created ile yanıt şemasını doğrular.
Test: Kullanıcı oluştur - Zorunlu alan eksik
email alanı eksik olan bir POST /users isteği gönderir ve yanıtın 400 Bad Request olduğunu doğrular.
Test: Tek kullanıcıyı getir - Başarılı
"Kullanıcı oluştur" testinden dinamik bir değişken kullanarak GET /users/{{userId}} çağrısı yapar ve 200 OK'i doğrular.
Test: Tek kullanıcıyı getir - Bulunamadı
GET /users/99999 çağrısı yapar ve 404 Not Found döndürdüğünü doğrular.
Test: Kullanıcıyı güncelle - Kimlik Doğrulama Gerekli
Bir Authorization başlığı olmadan PUT /users/{id} gönderir ve 401 Unauthorized'ı doğrular.
Bu, sadece bir istek kütüphanesi değil, mantıksal bir test paketidir. Yapay zeka ilişkileri ve sıralamaları anlar.
API Test Koleksiyonu Oluşturulduktan Sonraki En İyi Uygulamalar
"Oluştur"a tıkladığınızda işiniz bitmez, ancak ağır işler yapılmış olur. Yeni test paketinizi mükemmelleştirmek için işte yapmanız gerekenler:
- İncele ve İyileştir: Oluşturulan testleri gözden geçirin. Yapay zeka akıllıdır, ancak iş mantığınızı siz bilirsiniz. Belirli veri değerleri veya özel başlıklar için doğrulamalar ekleyin.
- Ortamları Yapılandırın: Apidog'da (örn.
Development,Staging,Production) ilgili temel URL'leriyle farklı ortamlar kurun. Test koleksiyonunuzu bu ortamlara bağlayın. - Test Veri Yönetimi Ekleyin:
POSTtestleri için daha gerçekçi veya çeşitli test verileri kullanmak isteyebilirsiniz. Apidog, istek gövdelerini kolayca düzenlemenizi sağlar. - Doğrulamaları Kurun: Yapay zeka temel durum kodu doğrulamalarını eklese de, bunları güçlendirmelisiniz. Yanıt süresi, belirli JSON şema doğrulaması veya belirli başlıkların mevcut olduğu gibi doğrulamalar ekleyin.
- Akışlar ve Zincirler Oluşturun: Testleri birbirine bağlayın.
POST /userstestinin çıktısını (yeni kullanıcının ID'si)GET /users/{id}vePUT /users/{id}testleri için girdi olarak kullanın. Apidog'un değişken çıkarma özelliği bunu görsel ve kolay hale getirir.
API Testini CI/CD Hattınıza Entegre Etme
Otomatikleştirilmiş bir test paketinin gerçek değeri, otomatik olarak çalıştığında ortaya çıkar. Apidog, test koleksiyonlarınızı dışa aktarmanıza veya CLI aracılığıyla çalıştırmanıza olanak tanıyarak CI/CD hattınıza entegrasyonu (Jenkins, GitHub Actions veya GitLab CI gibi) kolaylaştırır.
Hattınızdaki bu iş akışını hayal edin:
- Bir geliştirici, API'yi değiştiren kodu gönderir.
- CI sisteminiz, depodan en son OpenAPI spesifikasyonunu çeker.
- Yeni dağıtılan hazırlık ortamına karşı Apidog test paketini çalıştırır.
- Herhangi bir test başarısız olursa, spesifikasyondan bir sapma olduğunu göstererek, derleme işaretlenebilir veya başarısız sayılabilir, bu da hataların üretime ulaşmasını engeller.
Bu, döngüyü kapatır ve OpenAPI spesifikasyonunuzu hem geliştirmeyi hem de kalite güvencesini yönlendiren uygulanabilir bir sözleşme haline getirir.
Şema Odaklı API Testi Neden Daha İyi Ölçeklenir?
API'ler büyüdükçe, manuel test iyi ölçeklenmez.
Apidog ile şema odaklı test:
- API karmaşıklığıyla ölçeklenir
- Sürüm değişikliklerine uyum sağlar
- Bakım maliyetini azaltır
- Ekip işbirliğini geliştirir
Bu, büyük veya gelişen API'ler üzerinde çalışan ekipler için özellikle önemlidir.
Sonuç: Test Oluşturmayı Durdurun, Onları Üretmeye Başlayın
Eski iş akışı – tasarla, sonra manuel olarak testleri oluştur – verimsiz ve hataya açıktır. Apidog, OpenAPI spesifikasyonunuzu test üretimi için motor olarak kullanarak bu süreci yeniden tasarlar.
OpenAPI spesifikasyonlarınızı içe aktararak ve ardından Apidog'un yapay zekasını kullanarak test koleksiyonları oluşturarak güçlü bir şey başarırsınız: API sözleşmenizi yürütülebilir hale getirirsiniz. Testlerinizin kapsamlı, tasarımınızla uyumlu ve tek doğruluk kaynağı geliştikçe bakımı yapıldığından emin olursunuz.
Bu sadece zamandan tasarruf etmekle ilgili değil (ki muazzam miktarda tasarruf sağlar). Doğrulamayı geliştirme yaşam döngünüzün dokusuna yerleştirerek API'lerinizin kalitesini ve güvenilirliğini artırmakla ilgilidir.
OpenAPI spesifikasyonunuzu sadece bir dokümantasyon olarak ele almayı bırakın. Onu kalite güvencenizin temeli olarak kullanmaya başlayın. Apidog'u bugün ücretsiz indirin, spesifikasyonunuzu içe aktarın ve yapay zekanın ilk test paketinizi dakikalar içinde oluşturmasına izin verin. Manuel, tekrarlayan kurulumdan akıllı, otomatik güvenceye geçişi deneyimleyin.