Apidog CLI vs inso (Insomnia CLI): CI İçin Hangi API Test Aracı?

Pipeline'ınız için bir CLI test çalıştırıcısı seçmek, basit bir soruya dayanır: API'lerinizi geliştirmede zaten ne çalıştırıyor ve CI'da neyi otomatikleştirmeye ihtiyacınız var? Ekibiniz Insomnia kullanıyorsa, inso bariz bir arkadaştır. Tasarım, mock, dokümantasyon ve testi tek bir platformda istiyorsanız, Apidog CLI hesabı değiştirir.

Her araç nedir

inso, Kong'un açık kaynaklı API istemcisi olan Insomnia'nın komut satırı arkadaşıdır. Terminale ve CI'ye üç şey getirir: istek koleksiyonlarını çalıştırma, birim test paketlerini çalıştırma ve OpenAPI spec'lerini lint etme. Insomnia masaüstü uygulamanızın kullandığı aynı verileri okur, böylece GUI'de istekler oluşturursanız, inso bunları başsız olarak çalıştırır.

Apidog CLI, tasarım, hata ayıklama, mock, dokümantasyon ve testleri tek bir çalışma alanında kapsayan hepsi bir arada bir API platformu olan Apidog için terminal çalıştırıcısıdır. CLI, bir projeden test senaryolarını ve koleksiyonlarını yürütür, veriye dayalı çalıştırmaları destekler ve raporları çeşitli formatlarda yayar. Ayrıca OpenAPI'yi içe aktarabilir ve uç noktalar, şemalar ve dallar gibi API kaynaklarını kod olarak yönetebilir.

Temel fark, tek bir test çalıştırmadan önce ortaya çıkar. inso, Insomnia ekosistemi için odaklanmış bir çalıştırıcı ve bir linter'dir. Apidog CLI, daha geniş bir platformun test yüzeyidir.

Apidog CLI ve inso: karşılaştırma tablosu

Tablo kısa versiyonudur. Aşağıdaki bölümler, ikisinden birini CI'ye entegre ettiğinizde gerçekten önemli olan farklılıkları açıklar.

Kurulum: brew ve Docker, Apidog yükleyicisine karşı

inso, çeşitli belgelenmiş kanallar aracılığıyla gönderilir. Yaygın olanlar:

# Homebrew
brew install inso

# Docker
docker pull kong/inso:latest

Windows, Linux ve macOS için doğrudan indirmeler de mevcuttur. Tarihsel olarak inso, `insomnia-inso` olarak npm'deydi, ancak Homebrew, Docker ve doğrudan indirmeler Kong'un bugün belgelediği yollardır. Docker görüntüsü, bir Node araç zincirini yönetmek istemediğiniz CI çalıştırıcıları için kullanışlıdır.

Apidog CLI, Apidog indirme sayfasından yüklenir ve Apidog projenizde bulunan senaryoları çalıştırır. Testler projeye bağlı olduğu için, CLI, elle senkronize tutmanız gereken yerel bir klasörü okumak yerine mevcut tanımı çeker. Tam bir kılavuz istiyorsanız, Apidog CLI kurulum kılavuzu ve eksiksiz CLI kılavuzu, kurulumu baştan sona kapsar.

Her birinin ne çalıştırdığı ve nereden okuduğu

Bu, apidog cli ve insomnia cli kararındaki en büyük pratik ayrımı gösterir.

inso, paketleri ve spesifikasyonları adıyla referans alır. Bir tasarım belgesini veya koleksiyonu görünen adıyla işaret edersiniz ve Insomnia'nın Git Senkronizasyonu tarafından oluşturulan çalışma dizininizdeki bir .insomnia dizininde veya uygulama yüklüyse Insomnia uygulamasının veri dizininde tanımı bulur. Konumu --workingDir veya --src ile geçersiz kılarsınız.

inso run test "Smoke Suite" --env "CI"
inso run collection "User API" --env "Staging"
inso script seed-data --env env_staging

Ad tabanlı model, ekibiniz .insomnia klasörünü kaydeder ve bunu gerçeklik kaynağı olarak kabul ederse temizdir. Bu, CI kontrolünüzün bu klasörün mevcut olmasını gerektirdiği ve adların sabit kalması gerektiği anlamına gelir.

Apidog CLI, Apidog projesinde bulunan test senaryolarını çalıştırır. Bir oturum açma veya erişim belirteciyle kimlik doğrulaması yapar, ardından seçilen bir ortama karşı bir senaryo veya koleksiyon çalıştırırsınız. Tanım projeden gelir, bu nedenle ekibinizin GUI'de oluşturduğu aynı senaryo CI'de çalışır, commit edilecek ve hizalı tutulacak bir klasör yoktur.

apidog run -t <senaryo-veya-koleksiyon> -e <ortam>

Her iki model de yanlış değildir. inso, Git tarafından kaydedilmiş yerel bir klasörü tercih eder. Apidog, senkronize edilmiş bir kayıt projesini tercih eder. Ekibinizin API tanımlarını zaten nasıl paylaştığına uyanı seçin.

Veriye dayalı test

Aynı senaryoyu birçok girdi satırında çalıştırmanız gerekiyorsa, bu önemlidir.

Apidog CLI, bir CSV veya JSON veri kümesine işaret eden -d ile doğrudan veriye dayalı testi destekler. Her satır kendi değişkenleriyle bir yineleme haline gelir, bu nedenle bir senaryo düzinelerce vakayı kapsar.

apidog run -t "Checkout Flow" -e "Staging" -d ./datasets/orders.csv

Değişkenlerin sütunlarla nasıl eşlendiği dahil olmak üzere tam kalıp, Apidog CLI ile veriye dayalı test kılavuzundadır.

inso, çalıştırma komutlarında veriye dayalı bir bayrak sunmaz. Ortamlar aracılığıyla parametreleştirebilir ve CI işinizde inso etrafında betik yazarak yinelemeleri yönlendirebilirsiniz, ancak satır satır CSV/JSON yinelemesi, Apidog'da olduğu gibi birinci sınıf bir CLI özelliği değildir. Bir veri kümesi üzerinde yineleme, paketinizin merkezinde yer alıyorsa, bu gerçekten dikkate alınması gereken bir farklılıktır.

Raporlayıcılar: geri aldığınız şeyler

Raporlar, CI'nin size ne olduğunu bildirme şeklidir. Her iki araç da başarısız bir iddia durumunda yapıyı başarısız kılar, ancak çıktı formatları açısından farklılık gösterirler.

Apidog CLI, CLI, HTML ve JSON formatlarında raporlar üretir. CLI formatı hızlı günlük taraması için iyidir, HTML size paylaşılabilir bir yapıt sağlar ve JSON panolara veya aşağı akış araçlarına beslenir. Barındırılan, bağlantı kurulabilir bir rapor için --upload-report ile sonuçları buluta da gönderebilirsiniz. Apidog CLI test raporları kılavuzu her formatı ayrıntılı olarak açıklar.

inso, test sonuçlarını konsola yazdırır ve çoğu CI sisteminin temel aldığı çıkış kodu aracılığıyla geçme/kalma sinyali verir. Bu temel ihtiyacı karşılar. Zengin bir HTML yapıtı veya ekstra araçlar olmadan barındırılan bir rapor istiyorsanız, Apidog size burada daha fazlasını sunar.

Linting: dürüst karşılaştırma

inso'nun gerçek bir avantaja sahip olduğu yer burasıdır ve aksini iddia etmek haksızlık olur.

inso, inso lint spec ile OpenAPI spec'lerini lint eder ve arka plandaki linter, Stoplight'ın iyi bilinen OpenAPI linter'ı olan Spectral'dir. Bu, stil rehberini uygulayabileceğiniz, sözleşme sorunlarını yakalayabileceğiniz ve spec kalitesine göre birleştirmeleri engelleyebileceğiniz anlamına gelir; hepsi testlerinizi çalıştıran aynı CLI'dan.

inso lint spec "Payments API"
inso export spec "Payments API" --output openapi.yaml

Spec-first tasarım uygulayan ve CI'da lint kurallarının uygulanmasını isteyen ekipler için, inso'yu seçmek için bu güçlü ve gerçek bir nedendir.

Şimdi Apidog için dürüst karşılığı. Apidog CLI'nin bağımsız bir OpenAPI linter'ı, stil rehberi, bölme, birleştirme veya paketleme komutu yoktur. Apidog, spec'leri içe aktardığınızda doğrular, bu yapısal sorunları yakalar, ancak bu içe aktarma sırasında yapılan bir doğrulamadır, CI'da bir stil rehberine karşı çalıştırdığınız bir lint komutu değildir. Apidog'un CLI'sinin Spectral'i değiştirmesini beklemeyin. Eğer pipeline'da sözleşme linting'i zorunlu bir gereklilikse ve ayrı bir Spectral adımınız yoksa, inso bunu kapsar ve Apidog kapsamaz.

Apidog'un bunun yerine yerini kazandığı yer entegrasyon ve kaynak yönetimidir, ki bu bir sonraki bölümdür.

Kaynak ve dal kodu olarak

Apidog CLI'nin inso'nun yapmadığı bir şeyi yapabilir: API kaynaklarını kod olarak yönetmek. Terminalden OpenAPI'yi içe aktarabilir ve uç noktalar, şemalar, ortamlar, dallar ve birleştirme istekleri ile çalışabilirsiniz. Bu, API tasarım değişikliklerini betiklemeye ve bunları testleri çalıştıran aynı otomasyona bağlamanıza olanak tanır.

inso, bir çalıştırıcı ve linter olarak kendi kulvarında kalır. Bir spesifikasyonu dışa aktarabilir, ancak uç noktaları düzenlemek veya dalları yönetmek için bir kaynak yönetimi CLI'si değildir.

API tanımlarının ve test çalıştırmalarının aynı CLI tarafından yönetilmesini isteyen ekipler için, Apidog'un kod olarak kaynak yüzeyi önemli bir avantajdır. Bu, inso ve apidog seçiminin genellikle bir çalıştırıcı sorusundan ziyade bir platform sorusuna dönüşmesinin bir nedenidir.

Platform entegrasyonu, açık kaynak ve fiyatlandırma

inso, açık kaynak bir ekosistemin parçasıdır. Insomnia'nın kendisi açık kaynaktır, bu da araçlarını incelemek veya kendi kendine barındırmak isteyen ekipler için caziptir. Planlama için dürüst bir not: 2023'te Insomnia 8, tepkiye neden olan zorunlu bir bulut/giriş hesabı tanıttı ve bu dönemde göç ve veri kaybı olayları yaşandı. Ekibiniz bu olayları dikkate alırsa, Insomnia veri kaybı kurtarma ve geçişi ve Insomnia verilerini kurtarma ve dışa aktarma hakkındaki yazılarımız ayrıntıları kapsar. Bunların hiçbiri, inso CLI'nin Spectral linting ile entegre edilmiş sağlam, ücretsiz bir çalıştırıcı olduğu gerçeğini değiştirmez.

Apidog, ücretsiz bir katmanı olan ticari bir platformdur. Amacı entegrasyondur: tasarım, mock, dokümantasyon, hata ayıklama ve testi tek bir yerde yaparsınız ve CLI, bu çalışma alanı için otomasyon yüzeyidir. Ayrı bir tasarım aracı, mock sunucu ve çalıştırıcıyı bir araya getirme zahmetine girmezsiniz. Daha geniş bir ürün görünümü için Apidog ve Insomnia ile Insomnia ve Apidog makalelerine bakın. Çalıştırıcıyı önce canlı bir API'ye karşı denemek isterseniz, Insomnia ile bir API nasıl test edilir ve komut satırından bir REST API test etme kılavuzları iyi başlangıç noktalarıdır.

CI entegrasyonu, kısaca

Her iki araç da bir pipeline'a aynı şekilde entegre olur: kurun, kimlik doğrulayın veya verinizi işaret edin, çalıştırın ve çıkış kodunun yapıyı kontrol etmesine izin verin.

# CI'da inso
- run: brew install inso
- run: inso run test "Smoke Suite" --env "CI"

# CI'da Apidog CLI
- run: apidog run -t "Smoke Suite" -e "CI" -r html,json

Eğer bunu inşa ediyorsanız, Apidog CLI CI/CD pipeline kılavuzu ve GitHub Actions rehberi kimlik doğrulama, önbellekleme ve rapor yüklemeyi kapsar. Çalıştırıcıya özgü kimlik doğrulama detayları Apidog CLI kimlik doğrulama kılavuzunda bulunur.

Karar

Tek bir kazanan yok. Dürüst karar, ekibinizin nasıl çalıştığına göre değişir.

Zaten Insomnia kullanıyorsanız, .insomnia klasörünü kaydediyorsanız ve testlerinizi çalıştıran aynı araçtan CI'da Spectral spec linting'in uygulanmasını istiyorsanız inso'yu seçin. Açık kaynak ekosistemi ve yerleşik linter gerçek güçlü yönlerdir ve ücretsiz, adla referans verilen bir çalıştırıcı Insomnia öncelikli ekiplere sorunsuz bir şekilde uyar.

Tasarım, mock, dokümantasyon ve test için tek bir platform istiyorsanız, -d aracılığıyla veriye dayalı çalıştırmalar, daha zengin raporlayıcılar (CLI, HTML, JSON ve barındırılan raporlar) ve kod olarak kaynak ve dal yönetimi ile Apidog CLI'yi seçin. Bağımsız bir CLI linter'ından vazgeçersiniz, ancak tasarladığınız şeyin test ettiğiniz şey olduğu entegre bir iş akışı kazanırsınız. Mevcut bir kurulumu taşımak basittir; inso'dan (Insomnia CLI) Apidog CLI'ye geçiş makalesine bakın.

Pratikte karşılaştırmaya hazır mısınız? Apidog'u indirin ve kendi API'nize karşı bir senaryo çalıştırın.