Çevrimiçi JSON SchemaDönüştürücüOpenAPI
Veri modellerinizi farklı standartlar arasında geçirmek zahmetli ve manuel bir işlem olabilir. Dönüştürücümüz JSON Schemabu süreci OpenAPIotomatikleştirerekJSON Schema, standart tanımlarını anında OpenAPISpesifikasyon(OAS) uyumlu formatlara dönüştürmenizi sağlar. İster Swagger dokümantasyonu oluşturuyor olun ister istek/yanıt gövdeleri tanımlıyor olun, bu araç doğruluk ve uyumluluğu garanti eder.
Neden geçiş JSON Schemayapmalısınız OpenAPI?
OpenAPI(Eski adıyla Swagger) bir alt kümesini kullanırken, ve gibi belirli anahtar kelimelerin farklı sürümler(Taslak 4, 7 veya 2019-09) ve 3.0/3.1 spesifikasyonları arasında JSON Schemanasıl ele alındığı konusunda kritik farklılıklar vardır .typenullableformatOpenAPI
Uyumluluk Açığını Kapatmak
OpenAPI3.0 sürümü, standart sürümden farklı belirli kısıtlamalara sahiptir JSON Schema. Dönüştürücümüz, dependenciesuyumlu mantığa dönüştürme veya typedizileri 'nin katı gereksinimlerini karşılayacak şekilde ayarlama gibi bu incelikleri ele alarak OpenAPIAPI dokümantasyonunuzun geçerliliğini korur.
API Geliştirmeyi Kolaylaştırın
API dokümanlarınız için veritabanı modellerinizi veya doğrulama şemalarınızı yeniden yazmak yerine, mevcut kodunuzu olduğu gibi yapıştırabilirsiniz JSON Schema. Bu, insan hatasını azaltır ve arka uç mantığınızı ve dokümantasyonunuzu mükemmel bir şekilde senkronize tutar.
Dönüştürücümüzün Başlıca Özellikleri
Aracımız, API spesifikasyonlarını yönetirken hassasiyet ve hıza ihtiyaç duyan geliştiriciler için tasarlanmıştır.
JSON Schema1. Çoklu Taslak Desteği
Kaynak şemanız Taslak 4, 7 veya 2020-12'ye dayanıyor olsun, motorumuz yapıyı tanımlar ve en yakın OpenAPIeşdeğerine eşler.
2. OpenAPI3.0 ve 3.1 Hazır
OpenAPI3.1 sürümü artık 2019-09 ile tamamen uyumludur JSON Schema. Ancak, hala 3.0 sürümünü kullanıyorsanız, uyumluluğu korumak için OpenAPIaracımız belirli alanları(örneğin nullable: trueyerine) otomatik olarak "düşürecektir".type: ["string", "null"]
3. Anında Doğrulama ve Biçimlendirme
Verileri dönüştürmekle kalmaz, aynı zamanda çıktıyı da güzelleştirir. OpenAPIBölümünüze yapıştırmaya hazır, temiz, girintili ve geçerli bir şema elde edersiniz components/schemas.
Dönüştürücü Nasıl Kullanılır
Kodunuzu yapıştırın: Kaynak kodunuzu JSON Schemagiriş düzenleyicisine kopyalayın.
Sürüm Seçin(İsteğe bağlı):OpenAPI Çıktının 3.0 veya daha yeni 3.1 standardı için optimize edilmesini isteyip istemediğinizi seçin .
Dönüştür'e tıklayın: Araç, mantığı işleyecek ve OpenAPI uyumlu sonucu çıktı penceresinde gösterecektir.
Kopyala ve Kullan: Swagger veya Redocly dokümantasyonunuz için yeni şemanızı almak üzere "Kopyala" düğmesini kullanın.
Dikkat Edilmesi Gereken Teknik Farklılıklar
"İptal Edilebilir" Özelliğin İşlenmesi
Standartta JSON Schema, boş değer alabilen bir alan genellikle `<null>` olarak tanımlanır type: ["string", "null"]. OpenAPI3.0type: string sürümünde ise bu, ayrı bir özellik kullanılarak `<null>` 'a dönüştürülmelidir nullable: true. Dönüştürücümüz bunu otomatik olarak halleder.
"Format" Anahtar Kelimesi
OpenAPIAnahtar kelimeyi doğrulama için daha kapsamlı bir şekilde kullanır format(örneğin, int32, int64, float, double). Aracımız, bu formatların dönüştürme sırasında korunmasını ve doğru şekilde eşleştirilmesini sağlar.
Sıkça Sorulan Sorular(SSS)
Bu dönüştürücü Swagger 2.0 ile uyumlu mu?
Odak noktası OpenAPI3.x olsa da, oluşturulan şemalar büyük ölçüde Swagger 2.0 ile uyumludur, ancak ilgili definitionsbölümde bazı ayarlamalar gerekebilir.
Verilerim tarayıcımdan ayrılıyor mu?
Hayır. Tüm dönüştürme mantığı, JavaScript kullanılarak tarayıcınızda yerel olarak gerçekleşir. Hassas API şemalarınız asla sunucularımıza gönderilmez.
Büyük ve karmaşık şemaları dönüştürebilir miyim?
Evet. Aracımız, performans düşüşü olmadan derinlemesine iç içe geçmiş şemaları ve büyük nesne tanımlarını işlemek üzere optimize edilmiştir.