GitHub Copilot'ta Apidog CLI Nasıl Kullanılır

GitHub Copilot'ın ajan moduna Apidog API testlerinizi çalıştırmayı öğretin. Bir talimat dosyası ekleyin, düzenle-test et-düzelt döngüsünde apidog run komutunu çalıştırın ve çıkış kodunu okuyun.

INEZA Felin-Michel

INEZA Felin-Michel

14 July 2026

GitHub Copilot'ta Apidog CLI Nasıl Kullanılır

Kurumsal İçin Apidog

Şirket İçi (On-Premises) Dağıtım

SSO ve RBAC

SOC 2 Uyumlu

Apidog Enterprise'ı Keşfedin

GitHub Copilot'ın aracı modu bir döngüdür: dosyaları düzenler, terminal komutlarını çalıştırır, çıktıyı okur ve sonra ne yapacağına karar verir. Peki neden API testleriniz bu döngüde değil? Bir GUI'nin arkasında Apidog'da dururlar, biri tıklamayı hatırladığında çalışırlar. Copilot onlara asla dokunmaz.

Çözüm, tek bir yapılandırma dosyasıdır. Apidog CLI, Apidog'da oluşturduğunuz test senaryolarını doğrudan bir terminalden çalıştıran bir npm paketi olan apidog-cli'dir. CLI yüklendikten ve Copilot var olduğunu bildikten sonra, aracı modu bir Apidog senaryosunu birim testlerinizi çalıştırdığı gibi çalıştırır: komutu ateşler, çıkış kodunu okur, eğer kırmızıysa kodu düzeltir.

Düğme

Henüz CLI'yi kurmadıysanız, önce bunu yapın. Apidog CLI'yı bir AI kodlama aracıyla nasıl kurarsınız başlıklı makale, npm kurulumunu, oturum açmayı ve ilk çalıştırmayı bir aracının yazmasıyla anlatır. Bu makale, apidog --version komutunun bir sayı yazdırdığını ve Apidog hesabınızın kimliğinin doğrulandığını varsayar.

Bu Hangi Copilot Hakkında

Copilot birden fazla üründen oluşur ve isimleri kafa karıştırıcı şekillerde örtüşür. Bu makale, kabuk komutlarını çalıştırabilen arayüzler hakkındadır.

Ana olanı VS Code'daki aracı modudur. Copilot Sohbet görünümünü açar, mod açılır menüsünü Aracı olarak değiştirirsiniz ve birden fazla dosyayı düzenleyebilir, terminal komutlarını çalıştırabilir ve görev tamamlanana kadar tekrarlayabilir. Bir komut çalıştırmak istediğinde, size komutu gösterir ve yürütmeden önce onay ister. Bu onay adımı tam olarak apidog run komutunun yerine oturduğu yerdir.

Hangi arayüzde olduğunuzu bilmeniz için iki ilgili arayüzü belirtmekte fayda var. Copilot kodlama aracısı, siz ona bir sorun atadığınızda GitHub Actions'ta eşzamansız olarak çalışır; düzenleyicinizde çalışmak yerine bir çekme isteği (pull request) oluşturur. Copilot CLI ayrı bir terminal istemcisidir. Her ikisi de komutları çalıştırabilir, ancak bu makale VS Code'daki aracı modunu hedef alır, çünkü kod yazarken oturduğunuz ve düzenle-test et-düzelt döngüsünün en sıkı olduğu yer burasıdır. Aşağıdaki kurulum, aynı talimat dosyasını okuyan kodlama aracı için de geçerlidir. Copilot aracı haline geldiğinde nelerin değiştiğine dair daha geniş bir genel bakış için GitHub Copilot'ın yeni kodlama aracısı makalesine bakın.

Bu ayrım önemlidir çünkü Copilot'ın proje kurallarını öğrenme kendine özgü bir yolu vardır ve bu mekanizma, bir kerelik "testlerimi çalıştır" komutunu Copilot'ın kendi başına başvuracağı bir şeye dönüştürür. Bu mekanizma, özel bir talimat dosyasıdır.

Adım 1: Apidog kurallarını Copilot'ın talimat dosyasına ekleyin

Copilot, depo özel talimatlarını tek bir dosyadan okur: deponuzun kök dizinindeki .github/copilot-instructions.md. Aracı modu, Copilot Sohbeti, kod incelemesi ve kodlama aracısı, depo özel talimatları hakkındaki GitHub belgelerine göre otomatik olarak yükler. Bunu, Claude Code için CLAUDE.md veya Codex için AGENTS.md gibi düşünün: Copilot'ın çalışmaya başlamadan önce bağlamına çektiği bir proje talimatları içeren düz bir Markdown dosyası.

Dosyayı oluşturun ve kısa bir Apidog bloğu ekleyin:

## Apidog CLI ile API testi

Bir API uç noktasını değiştirdiğinizde, görevin tamamlandığını
bildirmeden önce Apidog CLI ile doğrulayın. Çalıştırın:

    apidog run -t 812345 -e 671234 -r cli

- `apidog run`, her onay başarılı olduğunda 0, herhangi bir hata durumunda sıfır olmayan bir değerle çıkar.
  Özet metin iyi görünse bile, sıfır olmayan bir çıkışı başarısız bir test olarak kabul edin.
- Makine, `apidog login` aracılığıyla zaten kimlik doğrulaması yapılmıştır.
  `--access-token` bayrağını EKLEMEYİN ve asla bu dosyaya bir token koymayın.
- "Bilinmeyen seçenek" hatasıyla karşılaşırsanız, `apidog run --help` komutunu çalıştırın ve
  gerçek bayrakları kullanın. Tahmin etmeyin.

-t ve -e değerlerini bir sonraki adımdaki gerçek senaryo ve ortam kimliklerinizle değiştirin.

Bunu sohbette bahsetmek yerine talimat dosyasına yazın, çünkü sohbete yazılan bir senaryo kimliği oturum sona erdiğinde kaybolur. .github/copilot-instructions.md içindeki bir kimlik, bundan sonra her ekip arkadaşı, her aracı modu oturumu ve kodlama aracısının açtığı her çekme isteği için orada olacaktır. Kuralın yalnızca belirli dosyalara uygulanmasını isterseniz, GitHub ayrıca .github/instructions/NAME.instructions.md içinde yola özgü talimatları da destekler, ancak burada tek bir depo genelinde dosya yeterlidir.

Adım 2: Komutu Apidog'dan alın

apidog run komutunu elle yazmanıza gerek yok. Apidog sizin için oluşturur.

Test senaryosunu Apidog'da açın, CI/CD sekmesine gidin ve komutu kopyalayın. Doğru senaryo Kimliği (-t), ortam Kimliği (-e) ve bir raporlayıcı bayrağı ile tam olarak oluşur:

apidog run -t 812345 -e 671234 -r cli

Bu kimlikleri .github/copilot-instructions.md dosyanızdaki bloğa yapıştırın. Bu kimlikler doğruluk kaynağıdır; Copilot ve talimat dosyanız çeliştiğinde, CI/CD sekmesi kazanır. Tüm bayraklar ve raporlayıcılar için apidog run komut referansına bakın.

Adım 3: Aracı modunun testi çalıştırmasını sağlayın

VS Code'da Copilot Sohbet görünümünü açın ve mod açılır menüsünü Aracı olarak değiştirin. Aracı modu başlangıçta .github/copilot-instructions.md dosyasını yüklediği için CLI'nin orada olduğunu zaten bilir. API'nize dokunan bir değişiklik yapın veya doğrudan sorun:

Apidog API test senaryosunu çalıştırın ve bana sonucu söyleyin.

Copilot, talimat dosyanızdan apidog run komutunu verir. Aracı modu terminal komutlarını sessizce çalıştırmaz; komutu size gösterir ve yürütmeden önce onaylamanızı ister, böylece neyin çalıştırılacağını tam olarak görürsünüz. Onaylayın. -r cli raporlayıcı daha sonra entegre terminalde adım adım bir sonuç ve özet yazdırır; burada her isteği ve onaylamayı gerçekleşirken izlersiniz.

İki şey görmek isteyeceksiniz: çalıştırmanın yürütülmesini ve Copilot'ın hem özeti hem de çıkış kodunu raporlamasını. Komutu bir kez onaylarsanız, VS Code bu komut için seçiminizi çalışma alanında hatırlayabilir, böylece daha sonraki apidog run çağrıları tekrar istemeden yürütülür. Staging ortamına karşı salt okunur bir test senaryosu, izin verilmesi uygun olan güvenli, çalışma alanı içi komut türüdür.

Adım 4: Raporu Copilot içinde okuyun

Bir çalıştırma başarısız olduğunda (kırmızıya döndüğünde), rapor cevabı içerir. -r cli ile Copilot, terminalde okunabilir bir döküm alır: her istek, her onaylama ve hangisinin beklenen değere karşı gerçek değerle başarısız olduğu. Başarısız onaylama, tam alanı veya durum kodunu adlandırır, bu da Copilot'ın bir sonraki iterasyonda düzeltmeyi bulması için genellikle yeterlidir.

Bir tarayıcıda açabileceğiniz veya bir ekip arkadaşınıza verebileceğiniz bir rapor için HTML raporlayıcıyı ekleyin:

apidog run -t 812345 -e 671234 -r cli,html

html raporlayıcı, ./apidog-reports konumuna bağımsız bir dosya yazar. Listede cli öğesini tutun, böylece Copilot bir sonraki adımına karar vermek için okuduğu satır içi çıktıyı almaya devam eder. JUnit çıktısı CI kontrol panellerinin ayrıştırdığı her rapor biçimi için eksiksiz Apidog CLI kılavuzuna ve Apidog CLI test raporlarını nasıl okuyacağınıza bakın.

Copilot Kendi Döngüsünde Test Ediyor

Buradaki mesele, siz sormayı bıraktığınızda ve talimat dosyası ona söylediği için Copilot'ın senaryoyu kendi başına çalıştırmasıdır.

Bir ödeme yanıtı oluşturan bir işleyiciyi düzenleyen aracı modunu hayal edin. Döngüsü değişir. Kodu düzenler, sonra zafer ilan etmek yerine, Apidog senaryonuzu staging'e karşı çalıştırır, çıkış kodunu okur ve buna göre hareket eder. Yeşilse, devam eder. Kırmızıysa, raporu açar, hangi onaylamanın başarısız olduğunu (durum kodu, eksik alan, yanlış değer) okur, bir düzeltme denemesi yapar ve tekrar çalıştırır. API testi, Copilot'ın birim testlerinizi zaten çalıştırdığı aynı düzenle-test et-düzelt döngüsünün bir parçası haline gelir. Tek bir talimat yazdınız ve Copilot komutu zaten çalıştığı şekilde entegre etti.

Bu, herhangi bir aracı iş akışını güvenli kılan devret-sonra-doğrula modelidir. Copilot komutu çalıştırır ve sonucu okur; siz Apidog'da senaryoları görsel olarak yazmaya devam eder ve aracının çıkış kodlarını dürüstçe okuduğunu kontrol edersiniz. Daha geniş kalıp için API testi için AI aracılarını nasıl kullanacağınızı ve Apidog AI test donanımını inceleyin.

Copilot'ın CLI'yı Gerçekten Çalıştırdığını Doğrulayın

Aracılar, hak etmedikleri başarıyı raporlar ve Copilot da bir istisna değildir. Sorunları ne sıklıkla yakaladıklarına göre sıralanmış üç kontrol.

İlk olarak, komutun çalışıp çalışmadığını doğrulayın. Aracı modu, yürüttüğü komutları ve bunların çıktısını terminalde satır içi olarak gösterir. Tam apidog run ... satırını ve altında bir sonucu arayın. Copilot testleri çalıştırdığını söylüyorsa ancak komutu görmüyorsanız, hiç yapmadığı bir şeyi özetlemiştir. Tekrar çalıştırmasını isteyin ve ham çıktıyı göstermesini sağlayın.

İkinci olarak, önemli olan çıkış kodunu doğrulayın:

Bu apidog run komutunun çıkış kodu neydi?

apidog run, her onay başarılı olduğunda 0 ile, herhangi bir şey başarısız olduğunda ise sıfır olmayan bir değerle çıkar. Bu tek davranış, Copilot'ın veya bir pipeline'ın çalıştırmayı temiz bir geçit olarak ele almasını sağlar. Copilot'ın metni "testler geçti" dese de çıkış kodu sıfır değilse, çıkış kodu doğrudur.

Üçüncü olarak, gerçek senaryoyu kullandığını doğrulayın. Eğer bir çalıştırma "senaryo bulunamadı" hatasıyla başarısız olursa, Copilot bir Kimlik uydurmuş veya yanlış hatırlamış olabilir. -t ve -e değerlerini talimat dosyanız ve Apidog'un CI/CD sekmesinde oluşturduğu komutla tekrar kontrol edin. Apidog'dan gelen Kimlikler gerçektir.

İsteğe Bağlı: Apidog MCP sunucusunu bağlayın

Talimat dosyanızdan apidog run komutunu çalıştırmak, ihtiyacınız olan çoğu şeyi kapsar. Bir adım daha ileri gitmek için Apidog MCP sunucusunu bağlayın.

VS Code'daki aracı modu, Copilot'ı MCP ile genişletme hakkındaki GitHub belgelerine göre depo kökünüzdeki bir çalışma alanı .vscode/mcp.json dosyasından MCP sunucularını okur. Apidog MCP sunucusu, API spesifikasyonlarınızı MCP üzerinden açığa çıkarır, böylece Copilot kodu yazarken şemanızı okuyabilir, sadece sonradan değil. İş bölümü nettir: CLI testleri çalıştırır ve MCP, aracıya spesifikasyonu besler.

Bunun yerine Copilot kodlama aracısını GitHub Actions'ta çalıştırırsanız, MCP yapılandırması farklı bir yerde bulunur. Bunu, depo Ayarları altında, Bulut aracısı altındaki Copilot bölümüne JSON olarak eklersiniz, tüm sırlar COPILOT_MCP_ ön ekli Actions sırları olarak saklanır. .vscode/mcp.json dosyası, düzenleyicinizdeki aracı modu içindir.

Copilot Yanlış Yaptığında

Kurulum sırasında birkaç hata sıkça ortaya çıkar.

Talimat dosyasını yok sayar. Copilot genel bir komut veya hiçbir komut çalıştırmazsa, dosya yüklenmiyor olabilir. Adının tam olarak .github/copilot-instructions.md olduğundan, depo kökünüzdeki .github dizininde bulunduğundan ve VS Code ayarlarınızda özel talimatların etkinleştirildiğinden emin olun. Yanlış bir yol, Copilot'ın onu asla okumaması anlamına gelir.

Yine de bir erişim tokenı iletir. Copilot --access-token eklemeye çalışırsa, genel örneklerden tahmin yürütüyordur. Blok zaten ona eklememesini söylüyor, çünkü makine apidog login aracılığıyla kimlik doğrulaması yapılmıştır. Bu satırı pekiştirin ve asla gerçek bir tokenı talimat dosyasına koymayın. Kimlik doğrulama modeli için Apidog CLI kimlik doğrulamasını inceleyin.

Bir bayrak uydurur. "Bilinmeyen seçenek" hatası, Copilot'ın sürümünüzde olmayan bir bayrak tahmin ettiği anlamına gelir. Ona apidog run --help komutunu çalıştırmasını söyleyin ve oradan tam bayrağı kopyalayın, bu her zaman yüklü sürümünüz için doğrudur.

Başarısız bir çalıştırmayı başarılı olarak raporlar. En maliyetli olanı ve çıkış kodu kuralının hem talimat dosyanızda hem de doğrulama adımınızda olmasının nedeni budur. Özet ve çıkış kodu çeliştiğinde, çıkış kodu kazanır.

Günlük bir aracıdan test edilmiş bir döngüye

Kurulum budur. Kurulum kılavuzunu takip ederek apidog-cli'yi bir kez kurun, deponuzun .github/copilot-instructions.md dosyasına kısa bir Apidog bloğu ekleyin ve Copilot API testlerinizi nasıl çalıştıracağını ve kodu düzenlemek için zaten kullandığı aynı döngü içinde sonucu nasıl okuyacağını bilir. Bozuk bir uç nokta, Copilot değişik üzerinde çalışırken yakalanır, gönderildikten sonra değil.

Bir GUI'nin arkasındaki bir test, bir insan tıkladığında çalışır; tek satırlık bir komut ise Copilot ne zaman isterse çalışır. Apidog'da senaryoları görsel olarak oluşturmaya devam edersiniz ve aracınız onları siz izlemezken çalıştırır. Apidog'u indirin, bir senaryo oluşturun, apidog run komutunu .github/copilot-instructions.md içine bırakın ve Copilot'ın bir sonraki değişiklikte onu nasıl ele aldığını izleyin. Aynı komutu Copilot olmadan bir pipeline'da çalıştırmaya hazır olduğunuzda, GitHub Actions'taki Apidog CLI sırları, raporlayıcıları ve çıkış kodu kontrolünü kapsar.

API Tasarım-Öncelikli Yaklaşımı Apidog'da Uygulayın

API'leri oluşturmanın ve kullanmanın daha kolay yolunu keşfedin