TL;DR
Apidog VS Code eklentisi, API istekleri göndermenize, koleksiyonları yönetmenize, testler çalıştırmanıza ve çalışma alanlarını ekibinizle paylaşmanıza olanak tanır – üstelik editörünüzden ayrılmadan. Kurulum beş dakikadan az sürer: eklentiyi yükleyin, ücretsiz Apidog hesabınıza giriş yapın ve çalışma alanınız doğrudan VS Code'un kenar çubuğuna yüklenir.
Giriş
Apidog, API tasarımı, testi ve dokümantasyonu için bir masaüstü uygulaması olarak başladı. Zamanla, ekip aynı çalışma alanını doğrudan editörünüze getiren bir VS Code eklentisi yayınladı. Eklenti Apidog'u kopyalamaz – mevcut çalışma alanınıza bağlanır, böylece koleksiyonlar, ortamlar ve test senaryoları ister VS Code'da, ister masaüstü uygulamasında veya web arayüzünde olun, senkronize kalır.
Bu rehber, eklentiyi yükleme, çalışma alanınıza bağlanma, istek gönderme, testler çalıştırma ve VS Code eklentisini masaüstü uygulamasıyla birlikte kullanma gibi tüm iş akışını adım adım anlatır.
Adım 1: Apidog VS Code eklentisini yükleyin
VS Code'u açın ve sol kenar çubuğundaki Uzantılar simgesine tıklayın (veya Ctrl+Shift+X / Cmd+Shift+X tuşlarına basın).
Uzantılar Pazarı arama çubuğunda "Apidog" aratın. Apidog Inc. tarafından yayınlanan eklentiyi arayın – Apidog logosunu (stilize API harfleri içeren koyu bir simge) gösterir.
Yükle'ye tıklayın. VS Code eklentiyi yükler ve sol taraftaki Etkinlik Çubuğunuza bir Apidog simgesi ekler.
Kurulumdan sonra, Etkinlik Çubuğundaki Apidog simgesine tıklayın. VS Code, Apidog panelini kenar çubuğunda açar.
Adım 2: Apidog hesabınıza giriş yapın
Apidog paneli bir "Giriş Yap" düğmesi gösterir. Buna tıklayın.
Apidog'un kimlik doğrulama sayfasına bir tarayıcı sekmesi açılır. Zaten bir Apidog hesabınız varsa, e-postanızı ve şifrenizi girin. Bir hesabınız yoksa, "Kaydol"a tıklayın – ücretsiz katman yalnızca bir e-posta adresi gerektirir. Kredi kartı gerekmez.
Giriş yaptıktan sonra, tarayıcı bir onay gösterir ve VS Code'a geri dönmenizi ister. "VS Code'u Aç"a tıklayın veya manuel olarak VS Code'a geri dönün.
VS Code kimlik doğrulama el sıkışmasını tamamlar ve Apidog çalışma alanınızı kenar çubuğuna yükler.
Giriş yaptıktan sonra kenar çubuğu nasıl görünür: Sol panel, çalışma alanınızın ağaç görünümünü gösterir. En üstte, çalışma alanı adınızı görürsünüz. Bunun altında, koleksiyonlarınız klasörler olarak görünür. Her koleksiyon, klasör yapısına göre düzenlenmiş içindeki istekleri göstermek için genişler. Ortamlar, panelin üst kısmındaki bir açılır menüde görünür.
Adım 3: Koleksiyonlarınızda gezinin
VS Code'daki Apidog kenar çubuğu, Apidog çalışma alanınızdaki koleksiyon yapısını tam olarak yansıtır.
Bir koleksiyona göz atmak için, koleksiyon adının yanındaki oka tıklayın. Klasörleri ve istekleri göstermek için genişler. Klasörler daha sonra tek tek isteklere genişler.
Her istek, HTTP metodunu (yeşil renkte GET, mavi renkte POST, turuncu renkte PUT, kırmızı renkte DELETE) gösteren renkli bir rozetle birlikte bir satır öğesi olarak görünür. Bir isteğe tıklamak, onu VS Code editör alanında bir sekme olarak açar.
Arama çubuğunu kullanma: Apidog panelinin üst kısmında bir arama girişi bulunur. Koleksiyonlarınızı istek adına, URL'ye veya metoda göre filtrelemek için herhangi bir anahtar kelime yazın. Bu, çalışma alanınızda düzinelerce koleksiyon olduğunda kullanışlıdır.
Çalışma alanlarını değiştirme: Apidog hesabınız birden fazla çalışma alanına (kişisel, ekip veya projeye özel) aitse, panelin üst kısmındaki bir çalışma alanı seçici, aralarında geçiş yapmanızı sağlar.
Adım 4: İstek gönderin
Kenar çubuğundan bir isteği açtığınızda, ana editör alanına bir sekme olarak yüklenir. İstek arayüzü tanıdık bir düzene sahiptir:
Üst çubuk: Metot seçici (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS içeren açılır menü), URL alanı ve Gönder düğmesi.
URL'nin altındaki sekmeler: Parametreler, Başlıklar, Gövde, Kimlik Doğrulama, İstek Öncesi Komut Dosyaları, Testler, Ayarlar. Her sekme ilgili yapılandırma bölümünü açar.
Bir istek göndermek için:
- Üst çubukta metodu ve URL'yi onaylayın
- Başlıklar sekmesinde gerekli başlıkları ekleyin
- İsteğin bir gövdesi varsa (POST, PUT), Gövde'ye tıklayın ve içerik türünü (JSON, form verisi, ikili vb.) seçin
- Gönder'e tıklayın
Yanıt, sekmenin alt yarısında görünür. Durum kodunu, yanıt süresini ve yanıt boyutunu gösterir. Yanıtın altındaki sekmeler, gövdeyi (JSON ve XML için sözdizimi vurgulamasıyla), başlıkları, çerezleri ve test sonuçlarını görüntülemenizi sağlar.
Ortamları kullanma: Apidog panelinin üst kısmındaki ortam seçici, etkin ortamı ayarlar. {{base_url}} veya {{token}} gibi değişkenler, o ortamda tanımlanan değerlere çözümlenir. URL'leri düzenlemeden aynı isteği geliştirme, hazırlık veya üretim ortamlarına karşı çalıştırmak için ortamları değiştirin.
Adım 5: İstekleri düzenleyin ve oluşturun
Mevcut istekleri doğrudan VS Code'da düzenleyebilirsiniz. Değişiklikler otomatik olarak Apidog çalışma alanınızla senkronize olur.
Yeni bir istek oluşturmak için:
- Kenar çubuğunda bir koleksiyona veya klasöre sağ tıklayın
- "Yeni İstek"i seçin
- Boş bir istek sekmesi açılır
- Metodu, URL'yi, başlıkları ve gövdeyi ayarlayın
- Kaydetmek için
Ctrl+S/Cmd+Stuşlarına basın
Yeni istek kenar çubuğunda görünür ve Apidog masaüstü uygulamasından, web arayüzünden veya herhangi bir ekip arkadaşınızın VS Code'undan anında erişilebilir.
Yeniden adlandırma ve düzenleme: Kenar çubuğundaki herhangi bir isteğe veya klasöre sağ tıklayarak yeniden adlandırma, taşıma, çoğaltma ve silme seçeneklerine erişin. Sürükle ve bırak ile yeniden sıralama kenar çubuğunda çalışır.
Adım 6: Testleri çalıştırın
Apidog, her yanıttan sonra çalışan test onaylamalarını destekler. Açık bir isteğin Testler sekmesinde JavaScript tabanlı onaylamalar 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 tıkladıktan sonra, yanıt bölümündeki Testler sekmesi, hangi onaylamaların geçtiğini ve hangilerinin başarısız olduğunu, geçme/başarısız olma sayıları ve başarısızlıklar için hata mesajlarıyla gösterir.
Bir koleksiyonu çalıştırma: Kenar çubuğundaki bir koleksiyona veya klasöre sağ tıklayın ve "Koleksiyonu Çalıştır"ı seçin. Yinelemeleri, istekler arasındaki gecikmeleri ve ortamları ayarlayabileceğiniz bir çalıştırıcı paneli açılır. Tüm istekleri sırayla yürütmek için Çalıştır'a tıklayın. Sonuçlar, her isteğin onaylamaları için geçme/başarısız olma durumunu gösterir.
Adım 7: VS Code eklentisini ve masaüstü uygulamasını birlikte kullanın
VS Code eklentisi ve masaüstü uygulaması aynı çalışma alanını gerçek zamanlı olarak paylaşır. Bir "birincil" sürüm yoktur – bunlar aynı verinin iki görünümüdür.
Her ikisini de kullanan yaygın iş akışları:
Masaüstünde tasarım, VS Code'da test: API şemanızı tanımlamak, dokümantasyon yazmak ve sahte sunucular kurmak için Apidog masaüstü uygulamasını kullanın. Ardından, geliştirme ortamınızdan ayrılmadan istekleri çalıştırmak ve test onaylamaları yazmak için VS Code'a geçin.
Ekip API incelemesi: Bir arka uç geliştiricisi masaüstü uygulamasında bir uç noktayı günceller. Bir ön uç geliştiricisi Apidog eklentisiyle VS Code'u açar ve güncellenmiş isteği yeni parametrelerle hemen görür. Çekme isteği yok, içe aktarılacak JSON dosyası yok.
Bağlam içinde test yazma: Bir API tüketmek için VS Code'da kod yazıyorsunuz. Pencereleri değiştirmeden Apidog panelini açabilir, ilgili uç noktayı bulabilir, çalıştırabilir, yanıt şeklini kontrol edebilir ve kodunuza geri dönebilirsiniz – tüm süreç boyunca aynı uygulamada kalarak.
Masaüstü uygulamasının daha iyi yaptığı şeyler: Şema tasarımı, sahte sunucu kurulumu, API dokümantasyonu yayınlama ve çok sayıda ortamı yönetme. Bunlar, VS Code'dan referans alabileceğiniz ancak tam ekran masaüstü görünümünde yapılandırması daha kolay olan masaüstü uygulaması öncelikli özelliklerdir.
Adım 8: Ekibinizle paylaşın
Bir veya iki başka geliştiriciyle çalışıyorsanız, onları Apidog çalışma alanınıza ekleyin. Apidog web arayüzünden veya masaüstü uygulamasından çalışma alanı ayarlarınıza gidin ve ekip arkadaşlarınızı e-posta ile davet edin.
Daveti kabul ettikten ve VS Code eklentisini yükledikten sonra, kenar çubukları sizin gördüğünüz koleksiyonları gösterir. Ekledikleri veya değiştirdikleri herhangi bir istek anında herkes için görünür hale gelir.
Ücretsiz katman üç kullanıcıya kadar destekler. Değişiklikler Apidog'un bulutunda senkronize edilir – git işlemleri, dosya dışa aktarmaları, birleştirme çakışmaları yok.
SSS
Apidog VS Code eklentisi masaüstü uygulaması olmadan çalışır mı?Evet. Eklenti, Apidog çalışma alanınız için eksiksiz bir istemcidir. Eklentiyi kullanmak için masaüstü uygulamasını yüklemeniz gerekmez.
Apidog VS Code eklentisini çevrimdışı kullanabilir miyim?Çevrimdışıyken önbelleğe alınmış koleksiyonları görüntüleyebilir ve düzenleyebilirsiniz. Harici API'lere istek göndermek internet erişimi gerektirir (değişiklikleri senkronize etmek gibi). Tam çevrimdışı destek, Apidog çalışma alanınızın önbellek durumuna bağlıdır.
Mevcut Thunder Client veya Postman koleksiyonlarını nasıl içe aktarırım?Apidog masaüstü uygulamasında veya web arayüzünde İçe Aktar'a gidin ve uygun formatı (Thunder Client JSON, Postman koleksiyonu v2.1, OpenAPI vb.) seçin. İçe aktarılan koleksiyonlar çalışma alanınızda görünür ve VS Code eklentisinden anında erişilebilir.
VS Code eklentisi, Apidog'da yeni bir proje oluşturmakla aynı şey midir?Hayır. Eklenti, mevcut Apidog çalışma alanınıza bağlanır. Çalışma alanlarını masaüstü uygulamasından veya web arayüzünden oluşturur ve yönetirsiniz. VS Code eklentisi, bu çalışma alanlarında VS Code'dan çalışmanızı sağlayan bir istemcidir.
Birden fazla kişi aynı koleksiyonu aynı anda açık tutabilir mi?Evet. Eklenti, koleksiyonları düzenleme için kilitlemez. İki kullanıcı aynı isteği eş zamanlı olarak düzenlerse, son kaydetme geçerli olur. Koordineli düzenleme için masaüstü uygulamasının işbirliği özelliklerini kullanın.
Eklenti ortam değişkeni otomatik tamamlama özelliğini destekler mi?Evet. Bir URL veya parametre alanına {{ yazarken, eklenti etkin ortamdan kullanılabilir değişkenleri önerir. Bu, değişken adlarındaki yazım hatalarını önlemeye yardımcı olur.
Apidog VS Code eklentisi, API geliştirmeyi zaten VS Code içinde yapıyorsanız günlük sürücünüz olarak en iyi şekilde çalışır. Koleksiyonlarınız, ortamlarınız ve ekip çalışma alanınız pencereler arasında geçiş yapmadan erişilebilir olduğunda iki dakikalık kurulum maliyeti hızla karşılığını verir.