JSON ভ্যালিডেশন এবং স্কিমা ডিজাইন সেরা অনুশীলন

কেন JSON ভ্যালিডেশন গুরুত্বপূর্ণ

API আধুনিক অ্যাপ্লিকেশনের মেরুদণ্ড, এবং JSON তাদের সাধারণ ভাষা। কিন্তু সঠিক ভ্যালিডেশন ছাড়া, ত্রুটিপূর্ণ বা ক্ষতিকারক JSON আপনার সার্ভিস ক্র্যাশ করতে পারে, আপনার ডেটাবেস নষ্ট করতে পারে, বা নিরাপত্তা ঝুঁকি তৈরি করতে পারে। আমি একক অনুপস্থিত ফিল্ড বা অপ্রত্যাশিত টাইপের কারণে প্রোডাকশন আউটেজ দেখেছি। JSON ভ্যালিডেশন শুধু টাইপো ধরার বিষয় নয়—এটি চুক্তি প্রয়োগ, ত্রুটি বার্তা উন্নত এবং আপনার সিস্টেম রক্ষা করার বিষয়।

এই নিবন্ধে, আমরা JSON স্কিমা ডিজাইন এবং পেলোড ভ্যালিডেট করার জন্য ব্যবহারিক সেরা অনুশীলনগুলি কভার করব। আপনি REST API, GraphQL রিজলভার, বা মাইক্রোসার্ভিস তৈরি করছেন কিনা, এই নীতিগুলি আপনাকে রাতে ভালো ঘুমাতে সাহায্য করবে।

১. একটি স্পষ্ট স্কিমা দিয়ে শুরু করুন

একটি স্কিমা আপনার API-এর চুক্তি। এটি সংজ্ঞায়িত করে কোন ফিল্ডগুলি অনুমোদিত, তাদের টাইপ এবং কোনও সীমাবদ্ধতা। এটি ছাড়া, আপনি অন্ধভাবে উড়ছেন। আপনার ডেটা বর্ণনা করতে JSON Schema (একটি মানক শব্দভাণ্ডার) ব্যবহার করুন। এটি ভাষা-নিরপেক্ষ এবং ব্যাপকভাবে সমর্থিত।

একটি ব্যবহারকারী অবজেক্টের জন্য একটি ন্যূনতম উদাহরণ এখানে:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": { "type": "integer", "minimum": 1 },
    "name": { "type": "string", "minLength": 1 },
    "email": { "type": "string", "format": "email" },
    "age": { "type": "integer", "minimum": 0, "maximum": 150 }
  },
  "required": ["id", "name", "email"],
  "additionalProperties": false
}

মূল বিষয়: required বাধ্যতামূলক ফিল্ড নিশ্চিত করে; additionalProperties: false অজানা ফিল্ড প্রত্যাখ্যান করে (কঠোর API-এর জন্য উপযোগী)।

২. আগে এবং প্রায়ই ভ্যালিডেট করুন

এজে ভ্যালিডেট করুন—আপনার ব্যবসায়িক লজিক চালানোর আগে। এটি অবৈধ ডেটা ছড়িয়ে পড়া প্রতিরোধ করে। Node.js-এ, আপনি Ajv-এর মতো লাইব্রেরি ব্যবহার করতে পারেন; Python-এ, jsonschema; Go-তে, gojsonschema। সর্বদা আগত অনুরোধ এবং বহির্গামী প্রতিক্রিয়া ভ্যালিডেট করুন (বাগ ধরতে)।

Python-এ উদাহরণ:

from jsonschema import validate, ValidationError

try:
    validate(instance=request.json, schema=user_schema)
except ValidationError as e:
    return {"error": e.message}, 400

স্পষ্ট ত্রুটি বার্তা ফেরত দিন—এগুলি ক্লায়েন্টদের দ্রুত সমস্যা সমাধান করতে সাহায্য করে।

৩. বিবর্তনের জন্য ডিজাইন করুন

API পরিবর্তিত হয়। আপনার স্কিমা ক্লায়েন্টদের ভাঙা ছাড়াই সংযোজনগুলি মিটমাট করা উচিত। এই নিয়মগুলি অনুসরণ করুন:

• কখনও ফিল্ড সরান বা নাম পরিবর্তন করবেন না একটি সংস্করণ বাম্প ছাড়া।
• নতুন ফিল্ডগুলি ঐচ্ছিক করুন যদি তারা গুরুত্বপূর্ণ না হয়।
• আপনার URL-এ সংস্করণ ব্যবহার করুন (যেমন, /v1/users) বা মিডিয়া টাইপ।
• সংযোজনমূলক পরিবর্তন পছন্দ করুন—বিদ্যমানগুলি পরিবর্তন করার চেয়ে ফিল্ড যোগ করুন।

এই পদ্ধতি Postel-এর আইনের সাথে সামঞ্জস্যপূর্ণ: আপনি যা পাঠান তাতে রক্ষণশীল হন, আপনি যা গ্রহণ করেন তাতে উদার হন। কিন্তু খুব উদার হবেন না—কঠোর ভ্যালিডেশন বাগ তাড়াতাড়ি ধরে।

৪. টাইপ সাবধানে পরিচালনা করুন

JSON-এর সীমিত টাইপ রয়েছে: string, number, boolean, object, array, null। সতর্ক থাকুন:

• সংখ্যা: JSON পূর্ণসংখ্যা এবং ফ্লোটের মধ্যে পার্থক্য করে না। আপনার যদি পূর্ণ সংখ্যা প্রয়োজন হয় তবে type: integer ব্যবহার করুন।
• তারিখ: ISO 8601 স্ট্রিং ব্যবহার করুন (যেমন, 2026-01-15T10:00:00Z) এবং format: date-time দিয়ে ভ্যালিডেট করুন।
• Enums: অবৈধ অবস্থা এড়াতে মানগুলিকে একটি পরিচিত সেটে সীমাবদ্ধ করুন।
• Null বনাম অনুপস্থিত: null অনুমোদিত কিনা তা নির্ধারণ করুন। প্রায়শই, একটি ফিল্ড বাদ দেওয়া null পাঠানোর চেয়ে ভাল।

৫. আপনার ভ্যালিডেশন সুরক্ষিত করুন

ভ্যালিডেশন একটি নিরাপত্তা নিয়ন্ত্রণ। আক্রমণকারীরা পরিষেবা অস্বীকারের কারণ হতে অতিরিক্ত আকারের পেলোড, গভীরভাবে নেস্টেড অবজেক্ট বা অপ্রত্যাশিত টাইপ পাঠাতে পারে। এর সাথে প্রশমিত করুন:

• আকার সীমা: একটি নির্দিষ্ট আকারের বেশি পেলোড প্রত্যাখ্যান করুন (যেমন, 1MB)।
• গভীরতা সীমা: গভীরভাবে নেস্টেড JSON প্রতিরোধ করুন (যেমন, সর্বোচ্চ গভীরতা 10)।
• কঠোর স্কিমা: অপ্রত্যাশিত ফিল্ডের ইনজেকশন এড়াতে অতিরিক্ত বৈশিষ্ট্য নিষিদ্ধ করুন।
• স্ট্রিং স্যানিটাইজ করুন: ভ্যালিডেশনের পরেও, XSS প্রতিরোধে আউটপুট এস্কেপ করুন।

এছাড়াও, সার্ভারে ভ্যালিডেট করুন—শুধুমাত্র ক্লায়েন্ট-সাইড ভ্যালিডেশন বিশ্বাস করবেন না।

৬. ভ্যালিডেশন লাইব্রেরির জন্য একটি তুলনা টেবিল ব্যবহার করুন

সঠিক লাইব্রেরি নির্বাচন আপনার ভাষা এবং কর্মক্ষমতা প্রয়োজনীয়তার উপর নির্ভর করে। এখানে একটি দ্রুত তুলনা:

এই সমস্ত লাইব্রেরি JSON Schema প্রয়োগ করে, তাই আপনার স্কিমা পোর্টেবল।

৭. আপনার স্কিমা ডকুমেন্ট করুন

একটি স্কিমা তখনই উপযোগী যখন ডেভেলপাররা এটি বোঝে। OpenAPI (পূর্বে Swagger) বা JSON Schema-এর description কীওয়ার্ডের মতো টুল ব্যবহার করে আপনার স্কিমা থেকে API ডকুমেন্টেশন তৈরি করুন। প্রতিটি ফিল্ডের জন্য উদাহরণ অন্তর্ভুক্ত করুন।

দ্রুত পরিদর্শনের জন্য, আপনি একটি JSON formatter ব্যবহার করে ম্যানুয়ালি JSON ফরম্যাট এবং ভ্যালিডেট করতে পারেন। এটি স্কিমা ভ্যালিডেশনে ডুব দেওয়ার আগে সিনট্যাক্স ত্রুটি এবং কাঠামোগত সমস্যা চিহ্নিত করতে সহায়তা করে।

৮. আপনার স্কিমা পরীক্ষা করুন

স্কিমা হল কোড—তাদের পরীক্ষা করুন। আপনার ভ্যালিডেশন নিয়মগুলি প্রত্যাশিতভাবে কাজ করে তা নিশ্চিত করতে বৈধ এবং অবৈধ পেলোড সহ ইউনিট টেস্ট লিখুন। json-schema-test-suite-এর মতো টুল সাহায্য করতে পারে। এছাড়াও, ত্রুটিগুলি তাড়াতাড়ি ধরতে পরিষেবাগুলির মধ্যে চুক্তি পরীক্ষা বিবেচনা করুন।

FAQ

JSON Schema কী এবং কেন আমি এটি ব্যবহার করব?

JSON Schema হল JSON ডেটার কাঠামো বর্ণনা করার একটি মান। এটি আপনাকে টাইপ, প্রয়োজনীয় ফিল্ড এবং সীমাবদ্ধতা সংজ্ঞায়িত করতে দেয়, স্বয়ংক্রিয় ভ্যালিডেশন এবং ডকুমেন্টেশন সক্ষম করে। এটি ভাষাজুড়ে ব্যাপকভাবে সমর্থিত।

JSON ভ্যালিডেশনে অতিরিক্ত বৈশিষ্ট্যগুলি কীভাবে পরিচালনা করব?

ডিফল্টভাবে, JSON Schema অতিরিক্ত বৈশিষ্ট্য অনুমোদন করে। অজানা ফিল্ড প্রত্যাখ্যান করতে additionalProperties: false সেট করুন, যা নিরাপত্তা উন্নত করে এবং টাইপো ধরে। তবে, API বিবর্তনের সাথে সতর্ক থাকুন—কঠোর স্কিমা অতিরিক্ত ফিল্ড পাঠানো ক্লায়েন্টদের ভাঙতে পারে।

আমি কি অনুরোধ এবং প্রতিক্রিয়া ভ্যালিডেশনের জন্য JSON Schema ব্যবহার করতে পারি?

অবশ্যই। ডেটা অখণ্ডতা নিশ্চিত করতে আগত অনুরোধ এবং বহির্গামী প্রতিক্রিয়া উভয়ই ভ্যালিডেট করুন। প্রতিক্রিয়া ভ্যালিডেশন আপনার নিজের কোডে বাগ ধরে যা ক্লায়েন্টদের কাছে পৌঁছানোর আগে।

উপসংহার

JSON ভ্যালিডেশন এবং স্কিমা ডিজাইন শক্তিশালী API-এর ভিত্তি। স্পষ্ট স্কিমা সংজ্ঞায়িত করে, তাড়াতাড়ি ভ্যালিডেট করে, বিবর্তনের পরিকল্পনা করে এবং আপনার এন্ডপয়েন্টগুলি সুরক্ষিত করে, আপনি নির্ভরযোগ্য এবং রক্ষণাবেক্ষণযোগ্য সিস্টেম তৈরি করেন। একটি স্কিমা দিয়ে শুরু করুন, একটি ভ্যালিডেশন লাইব্রেরি বেছে নিন এবং পুঙ্খানুপুঙ্খভাবে পরীক্ষা করুন। আপনার ভবিষ্যতের আপনি (এবং আপনার ব্যবহারকারীরা) আপনাকে ধন্যবাদ জানাবে।