JSON Schema adalah kosakata yang memungkinkan Anda memberi anotasi dan memvalidasi dokumen JSON. JSON Schema menyediakan kontrak untuk data JSON Anda, dengan mendefinisikan struktur, tipe data, dan aturan validasi.Apidog menggunakan JSON Schema untuk mendefinisikan struktur body permintaan dan respons, sehingga memungkinkan validasi otomatis dan pembuatan dokumentasi untuk API Anda.Halaman ini menyediakan pengantar singkat tentang JSON Schema. Untuk detail spesifikasi lengkap, sintaks, dan fitur lanjutan, lihat Dokumentasi JSON Schema resmi. Apa itu JSON Schema?#
JSON Schema adalah alat yang andal untuk:Memvalidasi data JSON terhadap aturan yang telah ditentukan
Mendokumentasikan struktur JSON yang diharapkan
Menghasilkan data mock berdasarkan definisi skema
Memastikan konsistensi di seluruh permintaan dan respons API
Kasus Penggunaan Umum#
Mendefinisikan skema body permintaan untuk endpoint POST/PUT/PATCH
Menentukan struktur body respons untuk semua metode HTTP
Memvalidasi data yang masuk terhadap format yang diharapkan
Menghasilkan respons mock secara otomatis
Membuat dokumentasi API yang komprehensif
Pelajari Lebih Lanjut#
Mulailah dengan skema sederhana yang mendefinisikan tipe dasar dan bidang wajib, lalu secara bertahap tambahkan aturan validasi dan batasan sesuai kebutuhan.