VS Code İçinde Apidog Nasıl Kullanılır?

TL;DR

Apidog VS Code eklentisi, API istekleri göndermek, koleksiyonları yönetmek, testleri çalıştırmak ve ekip ile çalışma alanlarını paylaşmak için doğrudan editörünüzden ayrılmadan kullanılabilir. Kurulumu basittir: eklentiyi indirip yükleyin, Apidog hesabınıza giriş yapın, tüm koleksiyonlarınız ve ortamlarınız VS Code kenar çubuğunda senkronize olur.

Apidog'u bugün deneyin

💡 Apidog ücretsiz, hepsi bir arada bir API geliştirme platformudur. VS Code eklentisi, editörünüzü doğrudan Apidog çalışma alanına bağlayarak API'leri test etmenize, dokümantasyon yazmanıza ve ekibinizle işbirliği yapmanıza imkan tanır. Apidog'u ücretsiz deneyebilirsiniz, kredi kartı gerekmez.

Giriş

Apidog ilk olarak API tasarımı, testi ve dokümantasyonu için bir masaüstü uygulaması olarak başladı. Zamanla, aynı çalışma alanını doğrudan editöre getiren bir VS Code eklentisi yayınlandı. Bu eklenti, masaüstü veya web arayüzünde oluşturduğunuz koleksiyonlar ve ortamlarla senkronize çalışır. Yani, nerede olursanız olun, tüm verileriniz güncel kalır.

Bu rehberde; eklentiyi yükleme, hesabınıza bağlanma, istek gönderme, testleri çalıştırma ve masaüstü uygulamasıyla entegre çalışma gibi temel iş akışlarını adım adım nasıl uygulayacağınızı bulabilirsiniz.

Adım 1: Apidog VS Code Eklentisini Yükleyin

VS Code'u açın.
Sol kenar çubuğundaki Uzantılar simgesine tıklayın veya Ctrl+Shift+X (Mac için Cmd+Shift+X) tuşlarına basın.
Arama çubuğuna "Apidog" yazın.
"Apidog Inc." tarafından yayınlanan eklentiyi bulun (API harfli koyu logoyu arayın).
Yükle'ye tıklayın; Apidog simgesi sol etkinlik çubuğunuzda görünecek.
Kurulumdan sonra Apidog simgesine tıklayın ve Apidog panelini açın.

Adım 2: Apidog Hesabınıza Giriş Yapın

Apidog panelinde "Giriş Yap" butonuna tıklayın.
Tarayıcıda açılan Apidog oturum açma sayfasında e-posta ve şifrenizle giriş yapın ya da "Kaydol" seçeneğiyle ücretsiz hesap oluşturun (kredi kartı gerekmez).
Giriş sonrası tarayıcıda onay mesajı görürsünüz.
"VS Code'u Aç" seçeneğine tıklayın veya editöre manuel olarak geri dönün.
Kimlik doğrulama tamamlanınca, Apidog çalışma alanınız kenar çubuğunda açılır.

Kenar Çubuğu Görünümü:

Üstte çalışma alanı adınız,
Altında koleksiyonlar (klasör yapısında),
Her koleksiyon altında istekler ve klasörler,
Ortam seçici üstte açılır menüde bulunur.

Adım 3: Koleksiyonlarınızda Gezinme

Kenar çubuğunda koleksiyonlarınız tam hiyerarşiyle listelenir.
Bir koleksiyonu genişletmek için adının yanındaki oka tıklayın.
Her bir istek, HTTP metodunu renkli bir rozet olarak gösterir (GET: yeşil, POST: mavi, PUT: turuncu, DELETE: kırmızı).
Bir isteğe tıklayınca, editör alanında sekme olarak açılır.

Arama: Üstteki arama kutusuna anahtar kelime (istek adı, URL, metod) yazarak koleksiyonlarınızı filtreleyebilirsiniz.

Çalışma Alanı Değiştirme: Birden fazla çalışma alanınız varsa, üstteki açılır menüden geçiş yapabilirsiniz.

Adım 4: İstek Gönderme

Bir isteği açtığınızda, editörde şu alanları görürsünüz:

Üst Çubuk: Metot seçici (GET, POST, vb.), URL alanı, Gönder butonu.
Alt Sekmeler: Parametreler, Başlıklar, Gövde, Kimlik Doğrulama, İstek Öncesi Script, Testler, Ayarlar.

İstek göndermek için:

Üst çubukta metod ve URL’yi kontrol edin.
Gerekliyse Başlıklar sekmesinde header ekleyin.
Gövde gerekiyorsa (ör. POST/PUT), Gövde sekmesinden türü seçin (JSON, form-data vb.).
"Gönder"e tıklayın.

Yanıt, sekmenin alt yarısında görüntülenir. JSON/XML yanıtlar için sözdizimi vurgulaması, başlıklar, çerezler ve test sonuçları sekmeleri mevcuttur.

Ortam Kullanımı: Üstteki ortam seçiciden ortamı değiştirin. URL’de {{base_url}}, parametrelerde {{token}} gibi değişkenler seçili ortamdan otomatik olarak alınır.

Adım 5: İstekleri Düzenleme ve Oluşturma

Mevcut istekler doğrudan VS Code'da düzenlenebilir; değişiklikler otomatik olarak Apidog çalışma alanınızla senkronize olur.

Yeni bir istek eklemek için:

Kenar çubuğunda bir koleksiyon/klasör üzerinde sağ tıklayın.
"Yeni İstek" seçeneğine tıklayın.
Açılan boş sekmede metod, URL, başlıklar ve gövdeyi belirleyin.
Kaydetmek için Ctrl+S / Cmd+S tuşlarına basın.

Yeni istek hemen kenar çubuğunda görünür ve diğer istemcilerde (masaüstü, web, ekip VS Code) anında erişilebilir olur.

Yeniden Adlandırma ve Düzenleme: Sağ tıklayarak yeniden adlandırma, taşıma, çoğaltma, silme ve kenar çubuğunda sürükle-bırak ile sıralama yapılabilir.

Adım 6: Testleri Çalıştırma

Her isteğin Testler sekmesinde JavaScript tabanlı testler yazabilirsiniz:

pm.test("Status is 200", function () {
  pm.response.to.have.status(200);
});

pm.test("Response contains user id", function () {
  const json = pm.response.json();
  pm.expect(json.id).to.be.a('number');
});

"Gönder"e bastıktan sonra, yanıt bölümünün altındaki Testler sekmesinde hangi testlerin geçtiği/başarısız olduğu ve hata mesajları listelenir.

Koleksiyon Çalıştırma: Bir koleksiyon veya klasöre sağ tıklayıp "Koleksiyonu Çalıştır" seçeneğiyle tüm isteklere otomatik test uygulayabilirsiniz. Yineleme, istekler arası gecikme ve ortam seçimi de bu panelden ayarlanabilir.

Adım 7: VS Code Eklentisini ve Masaüstü Uygulamasını Birlikte Kullanma

VS Code eklentisi ve masaüstü uygulaması aynı çalışma alanına gerçek zamanlı erişir; biri birincil değildir, değişiklikler anında yansır.

Tipik Senaryolar:

Masaüstünde API şeması tasarlayıp, VS Code’da test ve kod ile paralel çalışabilirsiniz.
Ekipte biri masaüstünde uç noktayı günceller, diğeri VS Code’dan yeni parametreleri hemen görebilir.
Kod yazarken pencere değiştirmeden Apidog panelinden endpoint’i bulup, çalıştırıp, yanıta bakıp kodunuza dönebilirsiniz.

Masaüstü uygulamasında daha kolay yapılan işler: Şema tasarımı, sahte sunucu kurulumu, API dokümantasyonu yayınlama ve çoklu ortam yönetimi; bunlar masaüstünde daha kapsamlıdır, ancak VS Code eklentisiyle referans alınabilir.

Adım 8: Ekibinizle Paylaşım

Ekip çalışması için:

Apidog web veya masaüstünde çalışma alanı ayarlarına gidin.
Ekip arkadaşınızı e-posta ile davet edin.
Daveti kabul edip VS Code eklentisini kuranlar, tüm koleksiyonları gerçek zamanlı görür.
Herhangi bir değişiklik anında bulutta senkronize olur; git işlemleri veya dosya paylaşımı gerekmez.

Ücretsiz katman 3 kullanıcıya kadar destekler.

SSS

Apidog VS Code eklentisi masaüstü uygulamasız çalışır mı?

Evet, eklenti bağımsızdır. Masaüstü uygulamasına ihtiyacınız yoktur.

Çevrimdışı kullanabilir miyim?

Önbellekteki koleksiyonları çevrimdışı görüntüleyip düzenleyebilirsiniz. API istekleri ve bulut senkronizasyonu için internet gerekir.

Thunder Client veya Postman koleksiyonlarını nasıl içe aktarırım?

Apidog masaüstü veya web arayüzünde "İçe Aktar" bölümünden Thunder Client JSON, Postman v2.1, OpenAPI gibi formatları seçebilirsiniz. İçe aktarılan koleksiyonlar VS Code eklentisinde anında görünür.

VS Code eklentisi yeni proje oluşturabilir mi?

Hayır, eklenti mevcut çalışma alanlarına bağlanır. Yeni çalışma alanını masaüstü veya webden oluşturmalısınız.

Birden fazla kişi aynı koleksiyonu aynı anda açabilir mi?

Evet. Koleksiyonlar düzenleme için kilitlenmez; iki kişi aynı anda değiştirirse son kaydeden kazanır. Gelişmiş işbirliği için masaüstü uygulamasını tercih edebilirsiniz.

Ortam değişkenlerinde otomatik tamamlama var mı?

Evet. URL veya parametre alanında {{ yazınca, etkin ortamdan değişkenler önerilir.

Apidog VS Code eklentisi, API geliştirme iş akışınızı editörünüzden çıkmadan yönetmenizi ve ekibinizle etkili işbirliği yapmanızı sağlar. Hızlı kurulumla koleksiyonlarınıza, ortamlarınıza ve testlerinize anında erişin.