Softonic

OpenAPI Zorunlu Alan Kontrolü

Adım 1 / 2
Sonraki

Bir API tanımını bir ekip arkadaşına, bir müşteriye veya bir belge üreticisine vermeden önce zorunlu alanların yerinde olduğundan emin olun. Belgenizi yukarıya yapıştırın; araç version alanını, info.title alanını, info.version alanını ve paths alanını onaylar ve eksik olan her şeyi listeler.

Zorunlu alanlar nasıl kontrol edilir

  1. 1

    Belgeyi yapıştırın

    Spesifikasyonunuzu hâlâ üzerinde çalışıyor olsanız bile JSON veya YAML olarak yapıştırın.

  2. 2

    Kontrolü çalıştırın

    Sonuç adımına geçin. Eksik olan her alan kendi hatası olarak görünür.

  3. 3

    Eksikleri ekleyin

    Listelenen alanları aşağıdaki parçacıkları kullanarak dosyanıza ekleyin.

  4. 4

    Yeniden kontrol edin

    Güncellenmiş spesifikasyonu yapıştırın ve hiçbir hata gösterilmeyene kadar yeniden çalıştırın.

Dört zorunlu parça

Alan Nereye gider Örnek
Version alanı Üst düzey openapi: 3.0.3 veya swagger: "2.0"
info.title info içinde title: Orders API
info.version info içinde version: 1.0.0
paths Üst düzey En az ilk rotanızı içeren paths:

info.version değeri OpenAPI spesifikasyonunun sürümü değil, kendi API’nizin sürümüdür. Spesifikasyon sürümü zaten en üstte yazdığı için insanlar bunu sık sık atlar.

Her şeyin eksik olduğu bir örnek

servers:
  - url: https://api.example.com

Bu küçük belgede zorunlu parçaların hiçbiri yoktur. Rapor üç hatayı listeler:

Bulgu Tür
Missing ‘openapi’ or ‘swagger’ version field. Hata
Missing ‘info’ object. Hata
Missing ‘paths’ object. Hata

Tüm info nesnesi yoksa araç yalnızca bu tek hatayı bildirir ve title ile version alanlarını ayrıca listelemez. Her iki alanı içeren bir info ekleyin; bir sonraki çalıştırma bunlardan biri hâlâ eksikse bunu bildirecektir.

Başlangıç iskeleti

openapi: 3.0.3
info:
  title: Orders API
  version: 1.0.0
paths:
  /orders:
    get:
      summary: List orders

Bu iskelet her zorunlu alan kontrolünü geçer. Adları kendi adlarınızla değiştirin ve oradan genişletin. Yanıtlar, şemalar ve güvenlik bu kontrolün kapsamında değildir.

Bu kontrolü ne zaman çalıştırmalı

Sıfırdan yeni bir spesifikasyon başlattığınızda, koddan bir tane ürettikten sonra ve bunu başka bir araca içe aktaracak birine göndermeden önce çalıştırın. Birçok içe aktarıcı, ilk eksik zorunlu alanda kısa bir mesajla durur; bu yüzden hepsini tek seferde yakalamak birkaç gidiş dönüşten tasarruf sağlar. Ayrıca API taslağı çizerken info.version alanını unutan veya paths alanını atlayan yeni başlayanlar için faydalı bir hatırlatıcıdır.

Zorunlu alanlar geçtikten sonra bir sonraki faydalı eklemeler info altında kısa bir description, bir servers girdisi ve her işlem için bir operationId’dir. Bunların hiçbiri burada kontrol edilmez, ama spesifikasyonu daha kolay okunur kılar ve istemci kodu üretmeyi kolaylaştırır.

Sık Sorulan Sorular

Hayır. openapi alanı kullandığınız spesifikasyonun sürümünü belirtir. info.version ise kendi API’nizin sürümüdür, örneğin 1.0.0.

Anahtar bir nesne olarak var olmalıdır ve bu kontrol içinde rota olmasını gerektirmez. Yayımlamadan önce gerçek rotaları ekleyin.

title ve version kontrolleri yalnızca info nesnesi varsa çalışır. Nesneyi ekleyin ve alanlarının tam olup olmadığını görmek için yeniden çalıştırın.

Hayır. Burada yalnızca version alanı, info, title, version ve paths zorunludur. İşlem düzeyindeki ayrıntılar incelenmez.

İ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