Gunakan JSON Schema untuk mendokumentasikan kontrak API, memvalidasi payload JSON, dan menghasilkan data mock yang realistis untuk pengujian dan demo.
Langkah 1 – Mulai dari sampel nyata
- Tempel respons API nyata, request payload, atau config JSON ke formatter terlebih dahulu.
- Simpan satu contoh JSON kanonis per endpoint untuk menghindari schema drift.
Langkah 2 – Buat schema dasar
- Gunakan Schema Generator untuk menyimpulkan tipe, field wajib, dan struktur bersarang.
- Perbaiki deskripsi, format, dan constraint (min/max, pattern) untuk penggunaan produksi.
Langkah 3 – Validasi JSON terhadap schema
- Tempel schema dan payload nyata ke Schema Validator.
- Perbaiki error dengan memperbarui JSON sample (bug) atau schema (perubahan kontrak).
Langkah 4 – Buat data mock untuk pengujian
- Buka Mock Generator untuk membuat payload contoh yang realistis sesuai schema Anda.
- Gunakan seed + batch size agar data uji bisa direproduksi dan skalabel.
Langkah 5 – Bagikan dan gunakan ulang
- Simpan schema di version control dan tautkan di dokumentasi API Anda.
- Hasilkan kode bertipe (TypeScript/Java/dll.) dari JSON sample yang stabil.
Catatan penting tentang fitur JSON Schema
- Beberapa schema mengandalkan keyword lanjutan seperti
$ref, anyOf, oneOf, dan allOf. - Validator berbeda-beda dalam dukungan draft dan keyword; jalankan validator JSON Schema penuh di CI untuk pengujian kontrak yang ketat.
Contoh: JSON → JSON Schema (disederhanakan)
// JSON input
{
"id": 1,
"name": "Maeve Winters",
"active": true,
"tags": ["developer", "backend"]
}
// Generated schema (example)
{
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" },
"active": { "type": "boolean" },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "name", "active", "tags"]
}