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

GitHub Copilot’ın aracı modu; dosyaları düzenler, terminal komutlarını çalıştırır, çıktıyı okur ve sonraki adımı belirler. API testlerinizi de bu döngüye dahil edebilirsiniz: Apidog’da oluşturduğunuz senaryoları apidog-cli ile terminalden çalıştırın; Copilot sonucu ve çıkış kodunu okuyarak değişikliği doğrulasın.

Apidog'u bugün deneyin

Apidog CLI, Apidog test senaryolarını terminalden çalıştıran apidog-cli npm paketidir. Copilot bu komutu çalıştırabildiğinde, API testi düzenle-test-et-düzelt döngüsünün bir parçası olur: komutu başlatır, çıktıyı inceler ve çalıştırma başarısızsa düzeltme yapar.

Başlamadan önce CLI'nin kurulu ve kimliğinizin doğrulanmış olduğunu kontrol edin:

apidog --version

Kurulum, oturum açma ve ilk çalıştırma için Apidog CLI’yı bir AI kodlama aracıyla nasıl kurarsınız rehberini izleyin.

Bu rehber hangi Copilot arayüzü için?

Bu rehber, öncelikle VS Code içindeki Copilot Aracı modu içindir. Bu mod:

• Birden fazla dosyayı düzenleyebilir.
• Terminal komutları çalıştırabilir.
• Komut çıktısını okuyabilir.
• Görev tamamlanana kadar düzenle-test et-düzelt döngüsünü sürdürebilir.

Copilot Sohbet görünümünü açın ve mod seçicisinden Aracı seçeneğini kullanın. Copilot bir terminal komutu çalıştırmadan önce sizden onay ister; apidog run komutunu burada inceleyip onaylayabilirsiniz.

Aynı depo talimatları Copilot kodlama aracısı tarafından da kullanılabilir. Ancak bu araç GitHub Actions üzerinde eşzamansız çalışır ve pull request oluşturur. Copilot CLI ise ayrı bir terminal istemcisidir. Copilot’un aracı özellikleri hakkında daha fazla bağlam için GitHub Copilot’ın yeni kodlama aracısı yazısına bakın.

Adım 1: Apidog komutunu Copilot talimatlarına ekleyin

Copilot’un depo kurallarını otomatik yüklemesi için proje kökünde şu dosyayı oluşturun:

.github/copilot-instructions.md

GitHub’ın depo özel talimatları belgelerine göre Copilot Sohbeti, aracı modu, kod incelemesi ve kodlama aracısı bu dosyayı kullanabilir.

Dosyaya aşağıdaki 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 kendi Apidog senaryo ve ortam kimliklerinizle değiştirin.

Bu komutu yalnızca Copilot sohbetine yazmayın. Sohbet bağlamı oturumla birlikte kaybolabilir; .github/copilot-instructions.md içindeki kural ise ekip üyeleri, yeni aracı oturumları ve kodlama aracısının oluşturduğu pull request’ler için kalıcı olur.

Kuralları yalnızca belirli dosya veya dizinlerde uygulamak isterseniz, .github/instructions/NAME.instructions.md altında yola özgü talimatlar da tanımlayabilirsiniz. Bu senaryoda depo genelindeki tek dosya yeterlidir.

Adım 2: Çalıştırma komutunu Apidog’dan kopyalayın

apidog run komutunu elle oluşturmaya çalışmayın. Apidog, doğru senaryo kimliği, ortam kimliği ve raporlayıcı ile komutu üretir.

1. Apidog’da test senaryonuzu açın.
2. CI/CD sekmesine gidin.
3. Oluşturulan komutu kopyalayın.

Örnek:

apidog run -t 812345 -e 671234 -r cli

Bu komutu .github/copilot-instructions.md içindeki Apidog bloğuna yapıştırın.

Apidog’un CI/CD sekmesindeki komut doğruluk kaynağıdır. Talimat dosyanızdaki kimlikler ile Apidog’daki komut çelişirse, Apidog’un oluşturduğu komutu kullanın. Bayraklar ve raporlayıcılar için apidog run komut referansını inceleyin.

Adım 3: Copilot Aracı modunda testi çalıştırın

VS Code’da Copilot Sohbeti açın ve Aracı modunu seçin. Ardından API değişikliğinizi yaptıktan sonra şu istemi verin:

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

Copilot, talimat dosyasındaki komutu kullanmalıdır:

apidog run -t 812345 -e 671234 -r cli

Komutu çalıştırmadan önce Copilot size gösterir. Şunları kontrol edin:

• Komutta doğru -t senaryo kimliği var mı?
• Komutta doğru -e ortam kimliği var mı?
• --access-token gibi gereksiz bir sır aktarılıyor mu?
• -r cli raporlayıcısı mevcut mu?

Komutu onayladıktan sonra, entegre terminalde her isteğin ve doğrulamanın çıktısını izleyebilirsiniz.

Adım 4: Çıkışı ve çıkış kodunu değerlendirin

Copilot’un yalnızca özet metnini değil, terminal çıktısını ve çıkış kodunu da kontrol edin.

Başarısız çalıştırmalarda -r cli, aşağıdaki bilgileri terminalde görünür hale getirir:

• Çalıştırılan istekler
• Başarılı ve başarısız doğrulamalar
• Beklenen ve gerçek değerler
• Hatalı durum kodları
• Eksik veya yanlış alanlar

Copilot’a doğrudan şu soruyu da sorabilirsiniz:

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

Kural basittir:

• Çıkış kodu 0: Tüm doğrulamalar başarılıdır.
• Sıfır olmayan çıkış kodu: Çalıştırma başarısızdır.

Copilot “testler geçti” dese bile çıkış kodu sıfır değilse, çalıştırmayı başarısız kabul edin.

HTML raporu ekleyin

Tarayıcıda açılabilir veya ekip arkadaşlarınızla paylaşılabilir bir rapor istiyorsanız html raporlayıcısını ekleyin:

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

html raporlayıcısı bağımsız raporu ./apidog-reports dizinine yazar. Copilot’un terminalden çıktıyı okuyabilmesi için cli raporlayıcısını listede tutun.

JUnit ve diğer rapor formatları için eksiksiz Apidog CLI kılavuzuna ve Apidog CLI test raporlarını nasıl okuyacağınıza bakın.

Copilot’un düzenle-test et-düzelt döngüsü

Talimat dosyası eklendiğinde, API testi manuel bir kontrol adımı olmaktan çıkar ve Copilot’un çalışma döngüsüne girer.

Örneğin Copilot bir ödeme yanıtı oluşturan işleyiciyi düzenliyorsa, beklenen akış şudur:

1. Kod değişikliğini yapar.
2. apidog run komutunu çalıştırır.
3. Çıkış kodunu okur.
4. Test başarılıysa görevi tamamlar.
5. Test başarısızsa raporu inceler.
6. Hatalı durum kodunu, eksik alanı veya yanlış değeri düzeltir.
7. Testi yeniden çalıştırır.

Bu yaklaşım, API testini birim testleriyle aynı geri bildirim döngüsüne dahil eder.

Sorumluluk paylaşımı nettir:

• Siz Apidog’da senaryoları görsel olarak oluşturur ve korursunuz.
• Copilot komutu çalıştırır, raporu okur ve kod değişikliğini doğrular.
• Çıkış kodu, başarılı veya başarısız sonucu belirler.

Daha geniş yaklaşım için API testi için AI aracılarını nasıl kullanacağınızı ve Apidog AI test donanımını inceleyin.

Copilot’un CLI’yı gerçekten çalıştırdığını doğrulayın

Aracıların raporladığı başarıyı doğrulamak için üç kontrol uygulayın.

1. Terminalde komutu görün

Copilot çalıştırdığı komutu ve çıktıyı terminalde göstermelidir. Şunu arayın:

apidog run ...

Komut görünmüyorsa Copilot testi gerçekten çalıştırmamış olabilir. Ham terminal çıktısını göstermesini isteyin.

2. Çıkış kodunu doğrulayın

Özellikle başarısızlık durumlarında çıkış kodunu kontrol edin:

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

Çıkış kodu 0 değilse, test başarısızdır.

3. Doğru senaryo ve ortam kimliklerini kullanın

senaryo bulunamadı benzeri bir hata alırsanız, Copilot yanlış bir kimlik kullanmış olabilir.

Şunları karşılaştırın:

• .github/copilot-instructions.md içindeki -t ve -e değerleri
• Apidog’un CI/CD sekmesinde oluşturduğu komut

Kimlikleri Apidog’un oluşturduğu komuttan kopyalayın.

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

apidog run komutunu talimat dosyasından çalıştırmak çoğu iş akışı için yeterlidir. Copilot’un API spesifikasyonunu kod yazarken okuyabilmesini istiyorsanız Apidog MCP sunucusunu da ekleyebilirsiniz.

VS Code’daki Copilot Aracı modu, GitHub’ın Copilot’ı MCP ile genişletme belgelerine göre proje kökündeki şu dosyadan MCP sunucularını okuyabilir:

.vscode/mcp.json

Apidog MCP sunucusu, API spesifikasyonunuzu MCP üzerinden sunar. Böylece Copilot:

• Şemayı kod yazarken okuyabilir.
• Alanları ve uç noktaları bağlam içinde değerlendirebilir.
• CLI çalıştırılmadan önce daha doğru kod üretebilir.

Bu iki araç farklı sorumluluklara sahiptir:

Araç	Görev
Apidog CLI	Test senaryolarını çalıştırır ve sonucu üretir.
Apidog MCP	API spesifikasyonunu Copilot’a bağlam olarak sağlar.

Copilot kodlama aracısını GitHub Actions üzerinde kullanıyorsanız MCP yapılandırması farklı bir konumda yapılır: depo ayarlarında, Copilot bölümündeki bulut aracısı yapılandırmasına JSON olarak eklenir. Sırlar ise COPILOT_MCP_ önekli Actions secrets olarak saklanır. .vscode/mcp.json, VS Code’daki aracı modu içindir.

Sık karşılaşılan sorunlar

Copilot talimat dosyasını yok sayıyor

Copilot genel bir komut çalıştırıyor veya hiç komut çalıştırmıyorsa şunları kontrol edin:

• Dosya adı tam olarak .github/copilot-instructions.md mi?
• Dosya proje kökündeki .github dizininde mi?
• VS Code ayarlarında özel talimatlar etkin mi?

Yanlış dosya yolu, Copilot’un talimatları hiç yüklememesi anlamına gelir.

Copilot --access-token eklemeye çalışıyor

Makine zaten apidog login ile doğrulanmışsa, talimat dosyasına token yazmayın ve Copilot’un --access-token eklemesine izin vermeyin.

Kimlik doğrulama yaklaşımı için Apidog CLI kimlik doğrulamasını inceleyin.

Copilot geçersiz bir bayrak kullanıyor

Bilinmeyen seçenek hatası, Copilot’un yüklü sürümünüzde olmayan bir bayrağı tahmin ettiği anlamına gelir.

Tahmin etmek yerine şunu çalıştırın:

apidog run --help

Ardından yalnızca bu çıktıda gösterilen bayrakları kullanın.

Copilot başarısız çalıştırmayı başarılı raporluyor

Özet metni ile çıkış kodu çelişirse, çıkış kodunu esas alın.

0              → başarılı
sıfır olmayan  → başarısız

Bu kuralı hem Copilot talimat dosyanıza hem de ekip doğrulama sürecinize ekleyin.

Sonuç

Kurulum üç adımdan oluşur:

1. Apidog CLI’yı kurun.
2. Apidog’un CI/CD sekmesinden apidog run komutunu kopyalayın.
3. Komutu .github/copilot-instructions.md dosyasına ekleyin.

Bundan sonra Copilot, API değişikliklerinden sonra test senaryosunu çalıştırabilir, sonucu okuyabilir ve başarısızlık durumunda düzeltme döngüsüne devam edebilir. Bozuk bir uç noktayı, değişiklik gönderilmeden önce yakalama şansınız artar.

Apidog’da senaryoları görsel olarak oluşturmaya devam edin; Copilot ise bunları terminalden çalıştırsın. Apidog’u indirin, bir senaryo oluşturun ve apidog run komutunu Copilot talimatlarınıza ekleyin.

Aynı komutu Copilot olmadan CI pipeline’ında çalıştırmak istediğinizde, GitHub Actions’taki Apidog CLI rehberi sırları, raporlayıcıları ve çıkış kodu kontrolünü kapsar.