İçeriğe atla
%100 yerel

OpenAPI uç noktası listesi

Bir OpenAPI veya Swagger belgesinin her uç noktasını okunabilir bir tablo olarak listeleyin.

Giriş
Çıkış

OpenAPI uç noktası listesi

Bir OpenAPI veya Swagger belgesi yapıştırın — JSON veya YAML biçiminde, OpenAPI 3 veya Swagger 2 — ve bu araç her uç noktayı okunabilir bir listeye ayıklar. Bir spec dosyasını aldığınızda ve ayrıntılara dalmadan önce hızlı bir genel bakışa ihtiyacınız olduğunda kullanışlıdır: hangi rotalar var, neye ihtiyaç duyarlar ve ne döndürürler.

Listeyi HTTP metoduna veya etikete göre filtreleyin, API'nin bir kısmına odaklanmak için. Yol ve sorgu parametrelerini, istek gövdesinin içerik türünü, yanıt kodlarını ve bir uç noktanın kimlik doğrulamaya ihtiyaç duyup duymadığını açıp kapatın — araç işlem başına güvenlik gereksinimlerini okur, bir işlem bunu geçersiz kılmazsa belgenin genel güvenlik ayarına geri döner. "Eski uç noktaları atla" seçeneğini açarak spec'te kullanılmayan olarak işaretlenen rotaları gizleyin ve kaynak dosyayı açmadan ek bağlam için her uç noktanın özet alanını ekleyin.

Sonucu yola veya etikete göre sıralayın ve sonraki adımınıza uygun bir çıkış biçimi seçin: hızlı tarama için düz liste, dokümantasyon veya çekme isteğine yapıştırmak için Markdown tablosu veya bir elektronik tablo uygulamasında açmak için CSV. $ref yerine satır içi olarak tanımlanan parametreler tahmin edilmek yerine atlanır, çünkü bir referansı doğru şekilde çözmek için belgenin geri kalanı gereklidir.

Her şey tarayıcınızda yerel olarak çalışır — yapıştırdığınız API belirtimi cihazınızı asla terk etmez, bu özel veya yayınlanmamış bir hizmeti tanımlarken önemlidir. Sonucu kopyalayın, bir .txt dosyası olarak indirin veya çalışmaya devam etmek için doğrudan başka bir araca gönderin.

FAQ

Hem OpenAPI 3 hem de Swagger 2'yi destekliyor mu?
Evet. Her iki format de uç noktaları aynı şekilde "paths" bölümünde tutar, bu nedenle aynı okuyucu her iki sürümü de işler.
Bir uç noktanın kimlik doğrulamaya ihtiyaç duyup duymadığını nasıl belirler?
Önce işlemin kendi "security" alanını kontrol eder. Oradaki boş bir dizi, bu uç noktanın açıkça kimlik doğrulamayı devre dışı bıraktığı anlamına gelir; alan eksikse, araç belgenin genel "security" ayarına geri döner.
$ref referanslarını çözebilir mi?
Parametreler için hayır — $ref ile tanımlanan bir parametrenin satır içi adı yoktur, bu nedenle belgenin geri kalanını okuması gerekecekse atlanmak yerine çözülür.
Geçersiz veya ilgisiz bir belge işlenirse mi olur?
Açık bir mesaj göreceksiniz: biri geçerli olmayan JSON veya YAML metni için, diğeri belge düzgün şekilde ayrıştırılırsa ancak "paths" bölümü yoksa.
API belirtimim herhangi bir yere yüklenir mi?
Hayır. Ayrıştırma ve biçimlendirme tamamen tarayıcınızda gerçekleşir — yapıştırdığınız belge cihazınızı asla terk etmez.