API Testleri İçin En İyi Hafif Komut Satırı Araçları

Çoğu API test aracı, tek bir istek göndermeden önce bir pencere açmanızı, oturum açmanızı ve bir çalışma alanında tıklamanızı ister. Bu, ilk bakış için uygun olabilir. Ancak tek bir satır yazmak, yanıtı okumak ve devam etmek istediğiniz terminal için yanlış bir yaklaşımdır. Hafif komut satırı araçları sırayı tersine çevirir: araç aradan çekilir ve isteğin kendisi tüm etkileşimi oluşturur.

Burada "hafif" terimi belirli bir anlam taşır. Küçük bir kurulum, genellikle tek bir ikili dosya veya hızlı bir npx komutu. Hızlı başlangıç, böylece bir uç noktaya ulaşmak anında hissettirir. İlk isteği çalıştırmak için çok az veya hiç yapılandırma gerektirmez. jq veya grep'e yönlendirebileceğiniz terminal öncelikli çıktı. Bu, "hangi araç açık kaynak" veya "hangisinin en çok özelliği var" sorularından farklıdır. Bu, ayak izi ve sürtünme ile ilgilidir. Barındırılan GUI'leri de kapsayan daha geniş bir inceleme için, en iyi ücretsiz API test araçları derlemesine bakabilirsiniz.

Aşağıda, REST ve HTTP API'lerini test etmek için sekiz hafif CLI aracı bulunmaktadır; bunlar kabaca en küçüğünden ve en manuel olanından, CI'da tam test paketlerini çalıştıranlara doğru sıralanmıştır. Her bir girdi gerçek bir kurulum komutu, çalıştığını gösteren tek bir komut, en iyi olduğu alan ve dürüst bir sınırlama içerir. Sonuncusu, Apidog CLI, görsel olarak oluşturduğunuz senaryoları çalıştıran ve çıkış koduna göre bir işlem hattını yönlendiren hafif bir ikili dosyadır.

API Testi İçin Bir CLI Aracını “Hafif” Yapan Nedir

Birçok araç terminalde çalışır. Ancak hepsi hafif hissettirmez. Bu liste için, bir araç dört noktada niteliklidir:

• Küçük ayak izi. Tek bir ikili dosya, bir pip/npm kurulumu veya tek satırlık bir npx komutu. Öncelikle kurmanız gereken bir çalışma zamanı yok, ideal olarak bir arka plan hizmeti de yok.
• Hızlı başlangıç. Araç, ısınma süresi olmadan başlatılır ve isteği gönderir. Rust ve Go ikilileri burada kazanır; ağır bir çalışma zamanı başlatan her şey kaybeder.
• Düşük veya sıfır yapılandırma. İlk isteği proje dosyası, hesap veya oturum açma olmadan gönderebilirsiniz. Yapılandırma, kaydetmek ve tekrarlamak istediğiniz zamanlar için isteğe bağlıdır.
• Terminal-yerel çıktı. Sonuçlar, bir bakışta okuyabileceğiniz ve başka bir komuta yönlendirebileceğiniz bir biçimde yazdırılır. Çıkış kodları bir anlam ifade eder, bu nedenle CI (Sürekli Entegrasyon) bunları bir geçit olarak kullanabilir.

Araçlar ilk üç maddeyle öne çıkar; son iki madde dördüncüye dayanır, çünkü hafif bir ikili dosyanın bir işlem hattındaki yerini kazandığı yer burasıdır. Etkileşimli, elle bir uç noktaya vurma tarafını daha derinlemesine incelemek isterseniz, REST API testi için curl alternatifleri kılavuzu manuel istemcilere daha derinlemesine değinir.

curl: zaten yüklü olan temel

curl, neredeyse kesinlikle zaten sahip olduğunuz bir araçtır. macOS, çoğu Linux dağıtımı ve modern Windows ile birlikte gelir, bu nedenle en hafif kurulum hiç kurulum yapmamaktır. HTTP, HTTPS ve uzun bir protokol listesini destekler ve diğer tüm istemcilerin kendilerini ölçtüğü referans noktasıdır.

# Already on your machine; check the version
curl --version

# POST JSON and print only the HTTP status
curl -s -o /dev/null -w "%{http_code}\n" \
  -X POST https://httpbin.org/post \
  -H "Content-Type: application/json" \
  -d '{"user":"acme","plan":"pro"}'

En iyisi: hızlı tek seferlik istekler, betikler ve yeni bir şey yükleyemediğiniz herhangi bir ortam için. Dürüst sınırlama: ergonomisi eskidir. Başlıkları elle ayarlarsınız, JSON güzel biçimlendirilmez ve bir yanıtı doğrulamak, jq'ye yönlendirme ve çıkış kodunu kendiniz kontrol etme anlamına gelir. Gönderir ve gösterir; test etmez.

HTTPie: İnsanlar İçin curl

HTTPie, curl'un yaptığı istekleri, insanlar için oluşturulmuş bir sözdizimiyle yapar. Komut http'dir, başlıklar ve JSON alanları basit key=value çiftleridir ve çıktı varsayılan olarak renklendirilir ve biçimlendirilir. Python ile yazılmıştır, bu nedenle bir Python çalışma zamanına ihtiyaç duyar; bu da onu tek bir ikili dosyadan daha ağır yapar, ancak yine de tek satırlık bir kurulumdur.

python -m pip install httpie   # or: brew install httpie

# POST JSON: age:=24 sends a number, name= sends a string
http POST httpbin.org/post name=acme age:=24 plan=pro

En iyisi: bayraksız okunabilir çıktı istediğinizde bir API'yi elle keşfetmek için. Dürüst sınırlama: Python'un başlangıcı derlenmiş bir ikili dosyadan belirgin şekilde daha yavaştır ve temiz bir sisteme kurulum, Python orada değilse onu çekmek anlamına gelir. curl gibi, bu da bir istemcidir, bir test çalıştırıcısı değil; yanıtı okursunuz, üzerinde bir doğrulama yapmazsınız.

xh: HTTPie'nin Hızı Tek Bir İkili Dosyada

xh, HTTPie'nin dostane sözdizimini Rust'ta yeniden uygular ve tek bir statik olarak bağlanmış ikili dosya olarak gelir. Daha hızlı başlangıç ve ikili dosyanın kendisi dışında yüklenecek hiçbir şey olmadan aynı key=value ergonomisini ve renkli çıktıyı elde edersiniz. HTTP/2'yi destekler ve hatta --curl ile eşdeğer curl komutunu yazdırabilir.

brew install xh   # or: cargo install xh --locked

# Same syntax as HTTPie, faster start
xh POST httpbin.org/post name=acme age:=24 plan=pro

En iyisi: HTTPie hissini seven ancak çalışma zamanı olmayan tek ve hızlı bir ikili dosya isteyen geliştiriciler için. Dürüst sınırlama: her HTTPie özelliğini uygulamaz ve bir eklenti sistemi yoktur. HTTPie'den daha yeni olduğu için etrafındaki ekosistem daha küçüktür. Hala bir istemci, bir doğrulama motoru değil.

Hurl: CI'da Çalışan Düz Metin Testleri

Hurl, bu listenin "bir istek gönder"den "bir yanıtı test et"e geçtiği yerdir. Düz metin bir .hurl dosyasında yazılmış HTTP isteklerini çalıştırır ve sonuçları doğrular. Rust ile yazılmıştır, arka planda libcurl tarafından desteklenir ve çalışma zamanı olmayan tek bir ikili dosya olarak gelir. Testler neredeyse isteklerin kendisi gibi okunur, bu da onları bir çekme isteğinde incelemeyi kolaylaştırır.

brew install hurl   # or: cargo install --locked hurl

cat > login.hurl <<'EOF'
POST https://httpbin.org/post
{ "user": "acme", "plan": "pro" }

HTTP 200
[Asserts]
jsonpath "$.json.user" == "acme"
EOF

hurl --test login.hurl   # non-zero exit if an assertion fails

En iyisi: sürüm kontrolünde okunabilir metin olarak tuttuğunuz sözleşme tarzı kontroller ve duman testleri için. --test bayrağı onu temiz bir CI geçidi yapar; başarısız bir doğrulama sıfırdan farklı bir çıkış kodu döndürür. Dürüst sınırlama: HTTP odaklıdır, bu nedenle gRPC'yi yönlendirmez veya gerçek yük oluşturmaz. Karmaşık akışlar, bir betik dilinden ziyade daha fazla .hurl dosyası anlamına gelir.

Step CI: Çok Adımlı Akışlar İçin Tek Bir YAML Dosyası

Step CI, tek bir YAML dosyasında tanımlanan API iş akışlarını çalıştırır. Tek bir iş akışında REST, GraphQL, gRPC, tRPC ve SOAP'ı kapsar ve bir OpenAPI şemasına göre doğrulama yapabilir. npm'den yüklersiniz ve aynı dosyayı yerel olarak ve CI'da çalıştırırsınız. Bir testin aslında bir dizi olduğunda iyi okunur: oturum açma, bir jeton yakalama, bir sonraki çağrıda kullanma, sonucu kontrol etme.

npm install -g stepci

# workflow.yml describes steps, captures, and checks
stepci run workflow.yml

En iyisi: çok adımlı bir API akışını tanımlayan tek bir bildirimsel dosya isteyen, bir dizüstü bilgisayarda ve bir işlem hattında aynı şekilde çalışan ekipler için. Dürüst sınırlama: bir Node paketi olduğundan, bir Rust veya Go ikili dosyasından daha ağırdır ve bir çalışma zamanı taşır. Sürüm yayınlama hızı yavaşladı, bu nedenle üzerine bir işlem hattı kurmadan önce deponun son etkinliğini kontrol edin. Bu parçaların daha kapsamlı bir test planına nasıl uyduğunu görmek için API test stratejileri makalesine bakın.

k6: Terminalden Hafif Yük Testi

k6 farklı bir soruyu yanıtlar: "bu yanıt doğru mu" değil, "yük altında dayanır mı". Go ile yazılmıştır, tek bir statik ikili dosya olarak gelir ve betikleri düz JavaScript'tir. Minimum kaynak kullanımı için tasarlanmıştır, bu nedenle bir dizüstü bilgisayardan gerçek trafik gönderebilirsiniz. Eşikler, bir yük testini bir geçiş/başarısızlık kapısına dönüştürür; bir eşiği aşarsanız k6, bir işlem hattının başarısızlık olarak okuduğu 99 koduyla çıkar.

brew install k6   # or run via Docker: docker run grafana/k6

cat > load.js <<'EOF'
import http from 'k6/http';
import { check } from 'k6';
export const options = {
  vus: 10, duration: '30s',
  thresholds: { http_req_duration: ['p(95)<500'] },
};
export default function () {
  const res = http.get('https://httpbin.org/get');
  check(res, { 'status is 200': (r) => r.status === 200 });
}
EOF

k6 run load.js

En iyisi: bir küme kurmadan betik yazıp CI'da çalıştırmak istediğiniz performans ve yük kontrolleri için. Dürüst sınırlama: bir yük aracıdır, işlevsel bir test istemcisi değil; tek bir yanıtı gözden geçirmek için buna başvurmazsınız. Anlamlı senaryolar yazmak, JavaScript API'sini öğrenmek anlamına gelir.

Newman: Postman Koleksiyonunu Başsız Çalıştırma

Newman, Postman koleksiyonları için komut satırı çalıştırıcısıdır. Ekibiniz zaten Postman'da istekler ve testler oluşturuyorsa, Newman bu koleksiyonu CI'da ihtiyacınız olan GUI olmadan bir terminalden çalıştırır. Koleksiyonu (ve isteğe bağlı olarak bir ortamı) JSON olarak dışa aktarır ve Newman'ı buna yönlendirirsiniz.

npm install -g newman

# collection.json exported from Postman; -e passes an environment
newman run collection.json -e staging.json

En iyisi: Postman'a yatırım yapmış ve mevcut koleksiyonlarını bir işlem hattında başsız çalıştırmak isteyen ekipler için. Newman, bir test başarısız olduğunda sıfırdan farklı bir çıkış kodu döndürür, böylece CI'ı temiz bir şekilde yönlendirir. Dürüst sınırlama: bir Node paketidir ve yalnızca Postman formatındaki koleksiyonları çalıştırır, bu nedenle zaten bu ekosistemdeyseniz en kullanışlısıdır. Bir GUI'de oluşturulmuş testleri çalıştırır; yazma hala orada gerçekleşir.

Apidog CLI: Oluşturduğunuz Senaryoları Çalıştırın, CI'ı Çıkış Koduna Göre Yönlendirin

Apidog CLI, Apidog'un hafif ucudur. Apidog'da görsel olarak tasarladığınız test senaryolarını doğrudan bir terminalden çalıştıran bir npm paketi olan apidog-cli'dir. Test oluşturma kısmı GUI'de kalır, burada istekleri zincirleme, değişkenleri çıkarma ve doğrulamalar yazma hızlıdır; CLI ise bu senaryolardan birini başsız çalıştıran ve size bir çıkış kodu veren küçük parçadır. Apidog açık kaynak değildir, ancak ücretsiz katmanı ve bu CLI, ayrı bir istemci, çalıştırıcı ve yük aracını bir araya getirmeye entegre bir alternatif sunar.

npm install -g apidog-cli
apidog login --with-token <YOUR_TOKEN>

# Copy the exact command from your scenario's CI/CD tab
apidog run -t <scenario_id> -e <env_id> -r cli

Senaryo ve ortam kimliklerini tahmin etmenize gerek yok. Test senaryonuzu Apidog'da açın, CI/CD sekmesine gidin ve kimlikleri zaten doldurulmuş olan oluşturulan apidog run komutunu kopyalayın. -r cli raporlayıcısı terminalde adım adım bir sonuç ve özet yazdırır; bir CI kontrol panelinin sonuçları ayrıştırması gerektiğinde -r cli,junit ekleyin. Yukarıdaki araçlar gibi, apidog run, her doğrulama geçtiğinde 0 ve herhangi bir şey başarısız olduğunda sıfırdan farklı bir kodla çıkar, böylece bir işlem hattı bunu temiz bir geçit olarak kabul eder. Çıktısı, agentHints.nextSteps ile yapılandırılmış JSON'dur, bu da bir yapay zeka kodlama aracısının çalıştırmasını ve okumasını kolaylaştırır.

En iyisi: görsel bir düzenleyicide karmaşık, çok adımlı senaryolar oluşturmak isteyen ancak bunları CI'da veya bir aracıdan başsız çalıştırmak isteyen ekipler için. Dürüst sınırlama: curl veya xh'den farklı olarak, bir Apidog projesinde tuttuğunuz senaryolara bağlıdır, bu nedenle entegre platform seçeneğidir, çıplak bir HTTP istemcisi değildir. Tam komut seti için, Apidog CLI tam kılavuzuna, apidog run komut referansına ve Apidog CLI ile komut satırından bir REST API'sini nasıl test edeceğinize dair ayrıntılı açıklamaya bakın.

Nasıl Seçilir

Doğru araç, "bir istek gönder" aşamasının ne kadar ötesine geçmeniz gerektiğine bağlıdır.

Manuel çalışma için en baştan başlayın. Bir uç noktayı test etmek için curl veya xh'ye başvurun. Bu kontrollerin sürüm kontrolünde çalışmasını istediğinizde Hurl'a geçin. Soru yük testine döndüğünde k6'yı, testleriniz zaten Postman'da yaşıyorsa Newman'ı kullanın. Karmaşık bir senaryoyu bir düzenleyicide oluşturmayı ve her yerde başsız çalıştırmayı tercih ediyorsanız Apidog CLI'yı seçin. Bunları tam bir GUI'siz iş akışına karşı değerlendiriyorsanız, başsız API test aracı kılavuzu, herhangi bir arayüz olmadan testleri çalıştırmayı kapsar.

Hafif Araçlar Nerede İşe Yarar

Hafif CLI araçları, bir GUI'nin sizi yavaşlattığı günlerde kazanır: bir terminalin derinliklerindeyken, bir testin insan müdahalesi olmadan CI'da çalışması gerektiğinde ve giderek artan bir şekilde bir yapay zeka aracısının sizin için kontrolü çalıştırdığında. curl ve xh manuel döngüyü sıkı tutar. Hurl ve Step CI, özel istekleri tekrarlanabilir testlere dönüştürür. k6 yük sorusunu yanıtlar. Newman, Postman'da zaten oluşturduğunuzu çalıştırır.

Apidog CLI, bir test oluşturmak ile herhangi bir yerde çalıştırmak arasındaki boşluğu kapatır. Senaryoyu Apidog'da bir kez tasarlarsınız, ardından apidog run komutu onu bir terminalden, bir işlem hattından veya bir aracıdan çalıştırır ve çıkış kodu derlemenin başarılı olup olmadığına karar verir. Apidog'u indirin, bir senaryo oluşturun ve tüm döngünün nasıl kapandığını görmek için apidog run komutunu CI yapılandırmanıza ekleyin.