استفاده از خبرهای رونما در سایت‌های غیروردپرسی
توزیع خبر رونما
این راهنما برای سایت‌های اختصاصی، CMSهای دیگر و تیم‌های توسعه‌ای است که می‌خواهند محتوای رونما را در محصول خود دریافت و نمایش دهند.
قبل از کدنویسی، مدل استفاده را مشخص کنید
تیم فنی باید بداند محتوا قرار است مستقیم نمایش داده شود، در CMS مقصد ذخیره شود یا ابتدا وارد یک لایه میانی شود. این تصمیم روی تکرار، بروزرسانی، cache و مدیریت خطا اثر دارد.
- محتوا کجا ذخیره می‌شود؟
- شناسه یکتای خبر چیست؟
- بروزرسانی خبر موجود چگونه تشخیص داده می‌شود؟
- حذف یا اصلاح منبع چگونه مدیریت می‌شود؟
- در زمان قطع سرویس چه چیزی به کاربر نمایش داده می‌شود؟
نگاشت داده
فیلدهای منبع را کورکورانه به قالب مقصد متصل نکنید. برای هر فیلد مشخص کنید در سایت شما کجا و با چه معنایی استفاده می‌شود.
- عنوان
- خلاصه یا excerpt
- متن
- نوع محتوا
- زمان انتشار و بروزرسانی
- منبع و URL اصلی
- دسته‌ها یا موضوع‌ها
- تصویر، فقط اگر واقعاً برای همان محتوا ارائه شده باشد
همگام‌سازی و جلوگیری از تکرار
هر خبر باید بر اساس یک شناسه پایدار یا مرجع قابل اتکا شناخته شود. عنوان معیار مناسبی برای deduplication نیست، چون ممکن است تغییر کند یا دو خبر عنوان مشابه داشته باشند.
در بروزرسانی، سیستم باید تشخیص دهد رکورد جدید است یا نسخه جدید رکورد قبلی. زمان منبع و زمان دریافت را جدا نگه دارید.
اصلاحات و تغییرات
خبر آنلاین یک سند ثابت نیست. اگر منبع اصلاح یا تکمیل شود، معماری مقصد باید بتواند نسخه جدید را دریافت کند. اگر مقصد نسخه قدیمی را برای آرشیو نگه می‌دارد، نسخه عمومی نباید کاربر را درباره وضعیت فعلی گمراه کند.
مدیریت خطا
- Timeout نباید باعث ایجاد نسخه ناقص شود.
- پاسخ نامعتبر باید ثبت شود، نه اینکه به‌عنوان خبر منتشر شود.
- نبود یک فیلد اختیاری نباید کل فرآیند را از کار بیندازد.
- خطای authentication باید از «هیچ خبر جدیدی وجود ندارد» تفکیک شود.
- retry باید محدود و idempotent باشد تا محتوای تکراری نسازد.
چک‌لیست قبل از راه‌اندازی عمومی
- یک محتوای جدید را دریافت کنید.
- یک محتوای بروزشده را همگام کنید.
- قطع موقت اتصال را شبیه‌سازی کنید.
- دریافت مجدد همان خبر را تست کنید.
- منبع و لینک اصلی را بررسی کنید.
- نمایش RTL، موبایل و دسکتاپ را کنترل کنید.
- ثبت خطا و monitoring را بررسی کنید.
مستندات فنی نسخه
endpoint، روش authentication، schema، rate limit و سایر مقادیر فنی باید دقیقاً از مستندات نسخه واقعی سرویس گرفته شوند. این صفحه مقدار ساختگی یا حدسی ارائه نمی‌کند.