پرش به محتوای اصلی
یک شروع رایگان برای شما

۳ روز رایگان،
پنل تحلیلگر را تجربه کنید

ثبت‌نام کنید و با تأیید شماره موبایل، دسترسی آزمایشی سه‌روزه‌تان را فعال کنید.

✓ بدون نیاز به پرداخت✓ فعال‌سازی پس از تأیید موبایل
شروع رایگان ۳ روزه

ویژه کاربران جدید · یک دوره برای هر حساب

اعتبارسنجی JSON اخبار؛ مدیریت فیلد خالی و تغییر قرارداد

مصرف‌کننده باید بداند کدام فیلد برای کارش ضروری است. اعتبارسنجی JSON فقط بررسی درست بودن نشانه‌گذاری نیست. نوع، حضور و معنای مقدار نیز اهمیت دارد.

تیم khapi · ۲۰ آبان ۱۴۰۵ · ۳ دقیقه مطالعه
تصویر مفهومی ساختار درختی داده و مسیرهای بررسی پاسخ API

قرارداد مصرف‌کننده چیست؟

مصرف‌کننده باید بداند کدام فیلد برای کارش ضروری است. اعتبارسنجی JSON فقط بررسی درست بودن نشانه‌گذاری نیست. نوع، حضور و معنای مقدار نیز اهمیت دارد. قرارداد کوچک و روشن، خطا را زودتر آشکار می‌کند. سخت‌گیری بی‌دلیل روی فیلدهای اضافی هم می‌تواند اتصال را شکننده کند.

ساختار پاسخ khapi

در پاسخ موفق اخبار، articles آرایه رکوردهاست. اطلاعات تعداد و صفحه در کنار آن قرار دارد. این آرایه را با نام‌هایی مثل data یا items فرض نکنید. نمونه رسمی را مبنای قرارداد اولیه بگیرید. پاسخ خطا باید مسیر جداگانه‌ای از پاسخ موفق داشته باشد.

فیلدهای ضروری

برای آرشیو، شناسه و پیوند ممکن است ضروری باشند. برای نمایش، عنوان و منبع نیز اهمیت دارند. ضرورت هر فیلد را براساس مصرف خود تعیین کنید. اگر فیلد ضروری نامعتبر بود، رکورد را قابل بررسی نگه دارید. حذف خاموش آن، تشخیص مشکل داده را دشوار می‌کند.

مقدار خالی

summary، image_url یا زمان می‌توانند نیازمند مدیریت مقدار خالی باشند. null را با رشته خالی یا صفر یکی ندانید. برای نمایش، جایگزین روشن و کم‌ادعا انتخاب کنید. نبود تصویر نباید باعث ناپدید شدن خبر معتبر شود. نبود تاریخ هم نباید با تاریخ ساختگی پر شود.

نوع داده

آرایه tags را مانند متن ساده پردازش نکنید. شناسه عددی را پیش از عملیات موردنیاز بررسی کنید. تبدیل خودکار هر مقدار ممکن است خطای ورودی را پنهان کند. اگر تبدیل مجاز است، قاعده آن را مستند کنید. پیام خطا باید نام فیلد و علت را نشان دهد.

نمودار توضیحی درخت اعتبارسنجی از پاسخ شبکه به ساختار، فیلد ضروری و نوع داده

فیلد تازه

اضافه شدن یک فیلد اختیاری نباید برنامه را متوقف کند. فیلدهای ناشناخته را در صورت نیاز نادیده بگیرید. اما تغییر نوع فیلد ضروری باید آشکار شود. نسخه نمونه پاسخ را در مخزن پروژه نگه دارید. قرارداد مصرف‌کننده باید میان سازگاری و کنترل تعادل ایجاد کند.

نمونه‌های آزمون

یک پاسخ معمول، یک پاسخ خالی و یک رکورد ناقص بسازید. آرایه اشتباه و تاریخ نامعتبر را هم آزمایش کنید. پاسخ HTML را به‌عنوان حالت شکست وارد کنید. داده نمونه نباید کلید یا اطلاعات خصوصی داشته باشد. این آزمون‌ها بدون تماس با API قابل اجرا هستند.

قرنطینه رکورد مشکل‌دار

رکورد نامعتبر را با علت در محل محدود نگه دارید. باقی داده سالم می‌تواند طبق سیاست برنامه پردازش شود. تعداد رکوردهای کنارگذاشته‌شده باید در گزارش اجرا دیده شود. حجم ناگهانی خطا نیازمند توقف یا بررسی است. مسیر بازیابی باید پس از اصلاح داده امکان اجرا داشته باشد.

تغییر قرارداد

اگر پاسخ سرویس تغییر کرد، نمونه جدید را بررسی کنید. تفاوت را با تست‌های قبلی مقایسه کنید. تغییر پذیرفته‌شده باید با نسخه برنامه همراه باشد. خاموش کردن همه اعتبارسنجی‌ها راه‌حل سازگاری نیست. مصرف‌کننده باید بداند کدام فرضش دیگر معتبر نیست.

شروع با khapi

از مستندات API یک پاسخ نمونه بردارید. فقط نیازهای واقعی نمایش یا آرشیو خود را الزام کنید. حالت‌های شکست را پیش از اتصال زمان‌بندی‌شده آزمایش کنید. خطاها را بدون افشای اعتبارنامه ثبت کنید. قرارداد روشن، نگهداری اتصال را برای نفر بعدی آسان‌تر می‌کند.

منابع و ادامه مطالعه

اشتراک‌گذاری:

این مطلب چطور به کار شما بیاید؟

مفاهیم این مقاله را مستقیم در پنل khapi امتحان کنید:

آماده شروع هستید؟

۳ روز استفادهٔ رایگان از پنل تحلیلگر، مطابق محدودیت‌های دورهٔ آزمایشی و بدون نیاز به کارت بانکی.