Ana içeriğe geç

@powerduck/oas-document

React için üretime hazır OpenAPI belgelendirme bileşeni. Bir OAS belgesi vererek üst bilgi gezinmesi, açık ve koyu temalar, ağaç gezinmesi, kaydırma takibi, şema inceleme ve çok dilli kod örnekleri içeren Stripe tarzı eksiksiz bir API belgelendirme arayüzü elde edin.

  • Paket adı: @powerduck/oas-document
  • Sürüm:
  • Lisans: MIT

Kullanılan kitaplıklar: @powerduck/openapi-parser (doğrulama ve otomatik dönüştürme), @powerduck/tree (gezinme), @powerduck/md-editor (Markdown görüntüleme), @powerduck/openapi-codegen (istek kodu üretimi).

Özellikler​

  • Kullanıma hazır API belgeleri — Ayrıştırılmış nesne, JSON dizesi veya YAML dizesi kabul eder
  • Stripe tarzı düzen — Yapılandırılabilir üst bilgi, kenar çubuğu ağacı ve iki sütunlu işlem görünümü
  • Açık ve koyu temalar — Üst bilgiden değiştirilir, seçim localStorage’a kaydedilir
  • OAS 3.2’ye otomatik dönüştürme — @powerduck/openapi-parser ile doğrular ve dönüştürür
  • Kaydırmayla eşzamanlı gezinme — İkili arama kullanan pasif kaydırma dinleyicisi
  • Markdown görüntüleme — Açıklamalar @powerduck/md-editor ile görüntülenir
  • Çok dilli kod örnekleri — @powerduck/openapi-codegen ile üretilir
  • Şema inceleme — Genişletilip daraltılabilen iç içe özellik tabloları
  • Duyarlı düzen — Mobilde kenar çubuğu bir üst katman paneline dönüşür

Sonraki adımlar​