مولد مخطط JSON عبر الإنترنت

كيف يعمل توليد المخطط تحت الغطاء

توليد مخطط JSON من عينة JSON يتطلب أكثر من مجرد مطابقة الحقول بالأنواع. تستخدم هذه الأداة عدة خطوات رئيسية لضمان الدقة والكمال:

1. التحليل: تقوم الأداة بتحليل JSON الخاص بك وفقًا لمواصفة ECMA-404، مع تقديم تقارير مفصلة عن الأخطاء في حال وجود مدخلات غير صحيحة أو غير واضحة.
2. التحليل الهيكلي: تبني شجرة تمثّل بياناتك، وتصنّف كل خاصية وعنصر وفقًا لأنواع JSON Schema الأساسية (كائن، مصفوفة، سلسلة نصية، رقم، عدد صحيح، منطقي، فارغ).
3. التنقل التكراري: يتم عبور الهياكل العميقة والمتداخلة - بما في ذلك مصفوفات الكائنات أو المصفوفات المتداخلة - بشكل تكراري لتوليد تعريفات مخطط متداخلة.
4. استدلال ودمج الأنواع: لكل خاصية أو عنصر مصفوفة، يتم استدلال الأنواع. حيث تكون الأنواع مختلطة، يُعبّر عن "النوع" كمصفوفة (نوع اتحاد) حسب مواصفة JSON Schema.
5. تمييز المطلوب من الاختياري: من خلال تحليل كافة الكائنات على كل مستوى، تميز الأداة بين المفاتيح الحاضرة دائمًا (مطلوبة) وتلك التي قد تكون مفقودة أحيانًا (اختيارية).
6. قيود القيم: حيثما أمكن، تستدل الأداة على المجموعات المحتملة للقيم (enums)، الحد الأدنى والأقصى للأعداد، الحد الأدنى والأقصى لطول السلاسل، وتلميحات التنسيق (مثل 'email'، 'uri'، أو 'date-time').
7. معالجة الحالات الخاصة: تعطي الأداة اهتمامًا خاصًا للمصفوفات الفارغة، القيم الفارغة null، والهياكل المتقطعة - لضمان مخططات صالحة تمثل تنوع الواقع الحقيقي.
8. تركيب المخطط: يُصدر المخطط النهائي كمستند متوافق مع مسودة-07 - جاهز للاستخدام مع أدوات مثل Ajv، OpenAPI، أو مكتبات توليد الشيفرة.

لماذا توليد مخطط JSON؟ استخدامات عملية

• التحقق التلقائي: استخدم المخططات المولدة لفرض عقود البيانات والتحقق من الحمولات الواردة في APIs، الخدمات الصغيرة، أو أدوات سطر الأوامر.
• توثيق API: أنشئ مستندات ومستكشفات تفاعلية (Swagger، Postman) أوتوماتيكيًا بتعريفات بيانات دقيقة.
• توليد الشيفرة: أنشئ نماذج أو أدوات تحقق آمنة الأنواع في TypeScript، Python، Java ولغات أخرى باستخدام مخططك كمصدر وحيد للحقائق.
• توليد بيانات اختبار: تستخدم أدوات مثل JSON Schema Faker أو Mockaroo المخططات لتوليد بيانات وهمية واقعية للاختبار وضغط الأداء.
• إعادة الهيكلة والترحيل: تحقق من صحة هياكل البيانات القديمة أو المتغيرة، مع ضمان التوافق أثناء تطور البنية الخلفية.

الميزات التقنية

• التوافق مع مسودة-07 لأقصى توافق مع أدوات التحقق ومنصات تصميم API الرائدة.
• تحليل تكراري لأي عمق تعشيش - مصفوفات داخل مصفوفات، كائنات داخل مصفوفات، والمزيد.
• استدلال دقيق لأنواع الاتحاد (مصفوفة للنوع) للحقل أو العناصر التي تختلف بين العينات.
• كشف تلقائي للمجموعات المحتملة (enums)، الطول، النمط، التنسيق، الحد الأدنى/الأقصى، وغيرها من القيود الشائعة.
• دعم صريح للقيم null، المصفوفات/الكائنات الفارغة، والسجلات الجزئية.
• يعمل توليد المخطط كاملاً داخل المتصفح، لا يغادر JSON الخاص بك جهازك أبدًا.

مثال تقني: من JSON عينة إلى مخطط مسودة-07

{
  "transaction": {
    "id": "txn_abc123",
    "amount": 99.95,
    "currency": "USD",
    "status": "completed",
    "meta": {
      "ip": "203.0.113.1",
      "tags": ["recurring", null]
    }
  },
  "refunded": false,
  "notes": null
}

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "transaction": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "amount": { "type": "number" },
        "currency": { "type": "string", "minLength": 3, "maxLength": 3 },
        "status": { "type": "string", "enum": ["completed"] },
        "meta": {
          "type": "object",
          "properties": {
            "ip": { "type": "string", "format": "ipv4" },
            "tags": {
              "type": "array",
              "items": { "type": ["string", "null"] }
            }
          },
          "required": ["ip", "tags"]
        }
      },
      "required": ["id", "amount", "currency", "status", "meta"]
    },
    "refunded": { "type": "boolean" },
    "notes": { "type": ["null"] }
  },
  "required": ["transaction", "refunded", "notes"]
}

كيفية استخدام أداة تحويل JSON إلى مخطط JSON

1. ألصق أو اكتب مثال JSON الخاص بك في المحرر أدناه. تقبل الأداة أي JSON صالح، من الكائنات البسيطة إلى الهياكل المتداخلة بعمق.
2. انقر على ’توليد مخطط JSON‘ لتوليد وعرض مخطط JSON الناتج.
3. انسخ المخطط، عدله، أو قم بتنزيله. دمجه مباشرة في تعريفات API، منطق التحقق، أو التوثيق.

أمثلة تعليمات برمجية لتوليد المخطط من JSON

اكتشف كيفية إنشاء مخطط JSON (JSON Schema) من بيانات JSON باستخدام لغات البرمجة المختلفة.

const generateSchema = require('jsonschema-generator');
const data = {
  name: "Alice",
  age: 30,
  isActive: true,
  tags: ["user", "admin"]
};
const schema = generateSchema(data);
console.log(JSON.stringify(schema, null, 2));

const GenerateSchema = require('generate-schema');
const data = { name: "Alice", age: 30, tags: ["admin", "user"] };
const schema = GenerateSchema.json('User', data);
console.log(JSON.stringify(schema, null, 2));

from genson import SchemaBuilder
sample = {"name": "Alice", "age": 30, "tags": ["user", "admin"]}
builder = SchemaBuilder()
builder.add_object(sample)
print(builder.to_json(indent=2))

from jsonschema_generate import generate_schema
sample = {"name": "Alice", "age": 30, "tags": ["user", "admin"]}
schema = generate_schema(sample)
print(schema)

package main
import (
  "encoding/json"
  "fmt"
  "github.com/invopop/jsonschema"
)
type User struct {
  Name string   `json:"name"
  Age  int      `json:"age"
  Tags []string `json:"tags"
}
func main() {
  schema := jsonschema.Reflect(&User{})
  out, _ := json.MarshalIndent(schema, "", "  ")
  fmt.Println(string(out))
}

# Generate Java POJOs *from* a JSON Schema, not the reverse.
# For schema generation from Java, see tools like jackson-module-jsonSchema.
# See: https://github.com/FasterXML/jackson-module-jsonSchema

using NJsonSchema;
using Newtonsoft.Json.Linq;
var sample = JObject.Parse("{\"name\":\"Alice\",\"age\":30, \"tags\":[\"user\"]}");
var schema = await JsonSchema.FromSampleJsonAsync(sample.ToString());
Console.WriteLine(schema.ToJson());

require 'vendor/autoload.php';
use Swaggest\JsonSchema\Structure\ClassStructure;
$sample = ["name" => "Alice", "age" => 30, "tags" => ["user"]];
$schema = ClassStructure::exportSchema($sample);
echo json_encode($schema, JSON_PRETTY_PRINT);

require 'json_schemer'
sample = { "name" => "Alice", "age" => 30, "tags" => ["admin", "user"] }
schema = JSONSchemer.schema(sample)
puts schema.to_json

echo '{"name":"Alice","age":30,"tags":["user","admin"]}' | genson | jq .

use schemars::JsonSchema;
use serde::Serialize;
#[derive(Serialize, JsonSchema)]
struct User {
  name: String,
  age: u32,
  tags: Vec<String>,
}
fn main() {
  let schema = schemars::schema_for!(User);
  println!("{}", serde_json::to_string_pretty(&schema).unwrap());
}

import json.schema._
case class User(name: String, age: Int, tags: List[String])
val schema = Json.schema[User]
println(schema.asSpray.prettyPrint)

# Generate schema from a TypeScript interface:
typescript-json-schema tsconfig.json User --out schema.json
# See https://github.com/YousefED/typescript-json-schema

// Dart does not have an automatic JSON Schema generator yet.
// Manually define schema as a Dart Map or use online tools.