यह online Scala case class → JSON Schema converter आपको real models (DTOs, structs और classes) से JSON Schema generate करने में मदद करता है ताकि आप payloads validate कर सकें, contracts share कर सकें और mock JSON generate कर सकें।
स्टेप 1 – अपना Scala source paste करें
- Left editor में वे models paste करें जिन्हें आप document करना चाहते हैं।
- Referenced types को उसी snippet में शामिल करें ताकि schema definitions generate कर सके।
- Sample button से example load करें और expected input format देखें।
स्टेप 2 – Root case class चुनें (जरूरत हो तो)
- यदि multiple definitions detect हों, तो अपने API payload से match करने वाला root चुनें।
- Output schema selected root के around बनता है और referenced types के लिए additional definitions शामिल कर सकता है।
स्टेप 3 – JSON Schema output review करें
- Types, required vs optional fields, और nested object/array structures check करें।
-
definitions और $ref देखें जब आपके models अन्य models को reference करते हों। - Validation, documentation या schema-first development के लिए schema copy/download करें।
स्टेप 4 – Validate करें या mock JSON generate करें
- Mock Data Generate करें पर क्लिक करके mock generator खोलें (schema preloaded रहेगा)।
- Breaking changes जल्दी पकड़ने के लिए real payloads को schema के विरुद्ध validate करें।
- यदि आप advanced schema composition (उदाहरण
anyOf/oneOf/allOf) पर निर्भर हैं, तो result को Ajv जैसे full validator से verify करें।
Schema keyword support note
Generated schemas में $ref शामिल हो सकता है और आप इसे edit करके anyOf, oneOf, या allOfजोड़ सकते/सकती हैं। Complex schemas के लिए full JSON Schema validator उपयोग करें और जरूरत हो तो mock generation से पहले dereference करें।