Softonic

OpenAPI Spesifikasyon Doğrulayıcı Online

Adım 1 / 2
Sonraki

Hata ve uyarıların bir listesini almak için yukarıya OpenAPI veya Swagger spesifikasyonunuzu yapıştırın. Bu sayfa her mesajın ne anlama geldiğini ve nasıl düzeltileceğini açıklar; böylece kırmızı bir rapordan temiz bir rapora hızlıca geçebilirsiniz. Hatalar belgeyi geçersiz kılar, uyarılar kılmaz.

Bir spesifikasyonu nasıl kontrol edersiniz ve rapora nasıl tepki verirsiniz

  1. 1

    Spesifikasyonu yapıştırın

    Belgenizi alana JSON veya YAML olarak yapıştırın.

  2. 2

    Sonuçları açın

    Geçerli mesajını ya da hata listesini görmek için sonuç adımına geçin.

  3. 3

    Her mesajı eşleştirin

    Aşağıdaki tabloda mesajı bulun ve düzeltmeyi kaynak dosyanıza uygulayın.

  4. 4

    Yeniden yapıştırın

    Hiçbir hata kalmayana kadar tekrar çalıştırın, ardından hangi uyarıları düzeltmeye değdiğine karar verin.

Hata mesajlarını okumak

Mesaj Anlamı Düzeltme
Could not parse as JSON or YAML. Metin iki biçimde de okunamıyor Sözdizimini düzeltin: fazladan virgüller, hatalı girintiler, kapanmamış parantezler
Missing ‘openapi’ or ‘swagger’ version field. Üst düzeyde sürüm anahtarı yok openapi: 3.0.3 veya swagger: "2.0" ekleyin
Missing ‘info’ object. info bölümü yok title ve version içeren bir info ekleyin
info.title is required. info içinde title yok info altına bir title ekleyin
info.version is required. info içinde version yok info altına bir version ekleyin (kendi API sürümünüz)
Missing ‘paths’ object. paths bölümü yok paths ekleyin, ilk başta boş olsa bile

Hatalar, belgenin geçerli olarak bildirilip bildirilmeyeceğini belirler. Önce hepsini düzeltin.

Uyarıları okumak

Mesaj Anlamı Düzeltme
Path ‘x’ should start with ‘/’. paths altındaki bir anahtar eğik çizgi ile başlamıyor /x olarak yeniden adlandırın
Unknown method ‘x’ on /path. Bir yol altındaki bir anahtar bilinen metotlar listesinde yok Yazım hatası olup olmadığını kontrol edin ya da bilerek eklediyseniz veya trace ise göz ardı edin

Bilinen anahtarların listesi get, post, put, patch, delete, head, options, parameters, summary, description ve servers alanlarından oluşur. x- ile başlayan satıcı uzantıları bu listede yer almaz, bu yüzden onlar da uyarı olarak görünür.

Online kontrolün söyleyemedikleri

Rapor yalnızca yapıyı kapsar. $ref bağlantılarını takip etmez, şema tanımlarını kontrol etmez ve eksik operationId değerlerini işaretlemez. Geçmeyi, dosyanın bir OpenAPI belgesinin biçimine uyduğunu onaylamak olarak görün; belge yayımlamadan veya istemci kodu üretmeden önce tam bir linter kullanın.

Uzun bir raporu adım adım işlemek için ipuçları

Üstten başlayın: bir ayrıştırma hatası, başka hiçbir şeyin güvenilir olmadığı anlamına gelir, bu yüzden önce onu düzeltin. Sonra üst düzeydeki eksik alanlarla ilgilenin, çünkü bunları eklemek hızlıdır. Yol uyarılarına ancak bundan sonra bakın. Her düzenleme turundan sonra bir parçayı değil tüm dosyayı yeniden yapıştırın, çünkü kontroller info ve paths alanlarını bulmak için tüm belgeye ihtiyaç duyar. Hiç hata olmayan ve birkaç bilinçli uyarı içeren bir rapor, normal ve kabul edilebilir bir son noktadır.

Sık Sorulan Sorular

Hatalar, belgenin geçerli olmadığı anlamına gelir. Uyarılar, baştaki eğik çizgisi olmayan bir yol gibi bakılmaya değer noktaları belirtir ama geçerlilik sonucunu değiştirmez.

Mutlaka değil. Üst düzey yapının yerinde olduğu anlamına gelir. Şemalar, referanslar ve yanıtlar incelenmez.

Bir yol altındaki anahtarlar, sabit bir HTTP metot listesi ve birkaç yol öğesi alanıyla karşılaştırılır. Bir x- anahtarı bu listede yer almaz, bu yüzden uyarı olarak işaretlenir. Bırakabilirsiniz.

Hayır. Kontrollerin sırasını izlerler: önce version alanı, sonra info, sonra paths. Satır numarası yoktur.

İlgili Araçlar

FPS Sayacı

requestAnimationFrame ile tarayıcı FPS değerini ölçün: yumuşatma, en düşük ve en yüksek kare hızı, uyarı eşiği ve isteğe bağlı grafik. Yerel çalışır, yükleme ve API yoktur.

Webpack Yapılandırma Oluşturucu

Saf JavaScript, React veya Vue için webpack 5 uyumlu bir webpack.config.js oluşturun: TypeScript, Babel, CSS veya Sass, görseller, HtmlWebpackPlugin, geliştirme sunucusu ve npm install satırı.

Tamamlayıcı Renk Bulucusu

Her girdi için tamamlayıcı renk belirleyin. HSL açısından tersi renk, bölünmüş tamamlayıcı çifti ve erişilebilir kombinasyonlar için öneriler geri verir.

Kurgusal telefon numarası oluşturucu

Beş ülkede resmen ayrılmış aralıklardan 50 adede kadar kurgusal numara üretin.

Telefon numarası doğrulayıcı

Telefon numarasının ülkeye göre yapısını denetleyin; bölge, tür, E.164, uluslararası, ulusal ve RFC 3966 biçimlerini görün.

Dosya Boyutu Dönüştürücü

Bayt, KB, MB, GB, TB ve ikili IEC birimleri (KiB, MiB, GiB, TiB) arasında, ondalık ve ikiliyi dilediğiniz gibi birleştirerek dönüşüm yapın.

Araç diğer dillerde mevcuttur

Rehberler ve kullanım örnekleri