Gamitin ang JSON Schema para i-dokumento ang API contracts, i-validate ang JSON payloads, at gumawa ng realistic mock data para sa tests at demos.
Hakbang 1 – Magsimula sa totoong sample
- I-paste muna ang totoong API response, request payload, o config JSON sa formatter.
- Mag-keep ng isang canonical JSON example kada endpoint para maiwasan ang schema drift.
Hakbang 2 – Mag-generate ng baseline schema
- Gamitin ang Schema Generator para ma-infer ang types, required fields, at nested structure.
- I-refine ang descriptions, formats, at constraints (min/max, patterns) para sa production use.
Hakbang 3 – I-validate ang JSON laban sa schema
- I-paste ang schema at mga totoong payloads sa Schema Validator.
- Ayusin ang errors sa pamamagitan ng pag-update ng JSON sample (bugs) o ng schema (contract changes).
Hakbang 4 – Gumawa ng mock data para sa testing
- Buksan ang Mock Generator para gumawa ng realistic sample payloads na tumutugma sa schema mo.
- Gamitin ang seed + batch size para maging reproducible at scalable ang test data.
Hakbang 5 – I-share at i-reuse
- I-save ang schemas sa version control at i-link sa API docs mo.
- Mag-generate ng typed code (TypeScript/Java/etc.) mula sa stable JSON samples.
Mahalagang paalala tungkol sa JSON Schema features
- May ilang schema na umaasa sa mga advanced keyword tulad ng
$ref, anyOf, oneOf, at allOf. - Magkakaiba ang validators kung gaano nila sinu-support ang drafts at keywords; gumamit ng full JSON Schema validator sa CI para sa striktong compliance.
Halimbawa: JSON → JSON Schema (pinadali)
// 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"]
}