JSON Swiss

JSON Swiss

Generator Ruby Class ke JSON Schema

Input Kode Ruby

Memuat editor…

Output JSON Schema

Pengaturan

Pilih class yang harus diperlakukan sebagai root JSON Schema.

Parsing berjalan sepenuhnya di browser Anda. Sumber Anda tidak pernah meninggalkan halaman.

Tempel class Ruby Anda untuk menghasilkan JSON Schema secara instan.

Mendukung deklarasi attr_accessor/attr_reader, class bersarang, dan metode yang diabaikan.

Cara mengonversi class Ruby menjadi JSON Schema – panduan langkah demi langkah

Konverter class Ruby ke JSON Schema online ini membantu Anda menghasilkan JSON Schema dari model nyata (DTO, struct, dan class) sehingga Anda dapat memvalidasi payload, membagikan kontrak, dan membuat JSON mock.

  1. Langkah 1 – Tempel sumber Ruby Anda

    • Tempel model yang ingin Anda dokumentasikan ke editor kiri.
    • Sertakan tipe yang direferensikan dalam snippet yang sama agar schema dapat menghasilkan definitions.
    • Gunakan tombol Contoh untuk memuat contoh dan melihat format input yang diharapkan.

  2. Langkah 2 – Pilih Class root (jika perlu)

    • Jika beberapa definisi terdeteksi, pilih root yang cocok dengan payload API Anda.
    • Output schema dibangun berdasarkan root yang dipilih dan dapat menyertakan definisi tambahan untuk tipe yang direferensikan.

  3. Langkah 3 – Tinjau output JSON Schema

    • Periksa tipe, field wajib vs opsional, serta struktur objek/array bersarang.
    • Cari definitions dan $ref saat model Anda mereferensikan model lain.
    • Salin atau unduh schema untuk validasi, dokumentasi, atau pengembangan schema-first.

  4. Langkah 4 – Validasi atau buat JSON mock

    • Klik Buat Data Mock untuk membuka mock generator dengan schema Anda yang sudah dimuat.
    • Validasi payload nyata terhadap schema untuk menangkap breaking change lebih awal.
    • Jika Anda mengandalkan komposisi schema lanjutan (misalnya anyOf/oneOf/allOf), verifikasi hasilnya dengan validator penuh seperti Ajv.

Catatan dukungan keyword schema

Schema yang dihasilkan dapat menyertakan $ref dan bisa diedit untuk menyertakan anyOf, oneOf, atau allOf. Untuk schema yang kompleks, gunakan validator JSON Schema penuh dan lakukan dereference sebelum membuat mock jika diperlukan.

Alat JSON Schema & pembuatan kode terkait

Gunakan alat-alat ini untuk memvalidasi schema, menghasilkan payload mock, memformat contoh JSON, dan menjaga sinkronisasi kode serta kontrak.

Generator Data Mock JSON Schema

Hasilkan contoh JSON dari schema Anda untuk pengujian, fixtures, dan dokumentasi.

Validator JSON Schema

Validasi JSON terhadap keyword schema umum dan temukan mismatch dengan cepat.

JSON ke Class Ruby

Hasilkan tipe dan model Ruby dari sample JSON.

Generator JSON ke JSON Schema

Bangun schema dari sample JSON representatif untuk melengkapi schema berbasis model.

Schema Library

Jelajahi contoh dan pola schema untuk objek, array, enum, dan constraint.

JSON Formatter

Bersihkan contoh JSON sebelum memvalidasi terhadap schema atau membagikan dokumentasi.

Pertanyaan yang Sering Diajukan

Konstruk Ruby apa yang didukung?

Parser berfokus pada class yang mengekspose atribut melalui deklarasi attr_reader/attr_accessor. Setiap atribut menjadi properti JSON Schema. Metode dan kode Ruby lainnya diabaikan, sehingga Anda dapat menempel class model polos dengan aman.

Bagaimana tipe atribut ditentukan?

Karena Ruby dinamis, atribut default ke `string` di schema. Anda dapat memperbaiki tipe dengan memberikan default literal; pembaruan berikutnya akan membaca komentar tipe. Untuk saat ini alat ini memberikan schema struktural cepat untuk DTO.

Mengapa menggunakan alat ini?

Saat membagikan domain object Ruby atau DTO seperti ActiveModel dengan tim lain, JSON Schema membantu mendokumentasikan payload dan memvalidasi kontrak. Konverter ini berjalan sepenuhnya di browser Anda.

Bagaimana mendapatkan payload JSON mock?

Setelah schema dibuat, klik "Buat Data Mock" untuk membuka Mock Generator dengan schema yang sudah dimuat dan membuat payload contoh secara instan.

Generator Ruby Class ke JSON Schema | JSONSwiss