پرش به محتویات

تغییرات

منتشرنشده

0.2.0 - ۱۴۰۵/۰۸/۲۴

تغییر کرده - آنچه از سرور بیرون می‌رود دیگر همان قبلی نیست:

  • cursor امضا می‌شود، با SECRET_KEY پروژه، و ترتیبی را که برایش ساخته شده با خودش دارد. cursorی که دستی عوض شده، برای ترتیب دیگری ساخته شده، یا با کلید دیگری امضا شده، پیش از اینکه از دیتابیس چیزی پرسیده شود 400 invalid_cursor می‌گیرد. cursorهایی که 0.1.0 داده رد می‌شوند: کلاینت فید را از اول می‌خواند. SECRET_KEY_FALLBACKS cursorها را با عوض شدن کلید نگه می‌دارد. cursor امضا شده است، نه رمزگذاری‌شده - مستندات حالا این را می‌گویند.
  • هر 5xx لاگ و گزارش می‌شود - خطای طراحی‌شده هم: APIExceptionی که با وضعیت 500 یا بالاتر raise شده، ServiceUnavailableError. همچنان پیامی را می‌گوید که با آن raise شده.
  • پاسخ 205 همان‌طور که view داده می‌ماند: بدنه‌ای ندارد که قالب در آن برود. success_response(status_code=205) رد می‌شود.

رفع شد:

  • باگی که حین خواندن یک فید رخ می‌دهد دوباره باگ است. جدا کردن cursorی که سرور نمی‌تواند به کار ببرد از یک ردیف خراب، به این معنا شده بود که هر ValueError، TypeError یا خطای دیتابیس حین خواندن صفحه invalid_cursor جواب داده شود - که باگ‌های خود پروژه را، بدون لاگ، در هر صفحه بعد از اولی پنهان می‌کرد. cursor امضاشده پیش از کوئری رد می‌شود، پس دیگر چیزی دور آن گرفته نمی‌شود.

  • cursorی که خوانده می‌شود ولی قابل استفاده نیست، 400 با invalid_cursor است، همان‌طور که قرارداد درباره‌ی هر cursorی که سرور نمی‌تواند بخواند می‌گوید. cursorی که با دست نوشته شده بود، یا بعد از مرتب‌سازی لیست با ستونی دیگر نگه داشته شده بود، 500 می‌داد - و مثل یک باگ لاگ و گزارش می‌شد - یا validation_error.

  • viewی که با cache_page روی متدش کش شده، دوباره کش می‌شود. گذاشتن پاسخ در قالب، کش را منتظر پاسخی می‌گذاشت که هرگز رندر نمی‌شد، و هر درخواست به view می‌رسید.
  • error_response تراکنش درخواست را برای rollback علامت می‌زند، مثل خطایی که raise شده. با ATOMIC_REQUESTS، چیزی که view پیش از برگرداندن خطا نوشته بود باقی می‌ماند.
  • چیزی که clean() مدل رد می‌کند زیر non_field_errors است، نه زیر کلید خود Django، یعنی __all__.
  • خطایی که با کد invalid raise شده همان کد را نگه می‌دارد. فقط خطای اعتبارسنجی validation_error است؛ ردّی که کد invalid داشت به همین نام فرستاده می‌شد، بدون data.fields.
  • خطایی که کلاسش کدی ندارد در قالب جواب داده می‌شود، با کد خود DRF یعنی error، نه با 500 خود Django.
  • سقفی که بالای صفر نیست، سقفی برای انتخاب نیست. viewی با max_page_size = 0 به کلاینتی که page_size می‌فرستاد کل لیست را بدون صفحه‌بندی جواب می‌داد؛ حالا با تعداد صفحه‌ی خودش جواب می‌دهد.
  • نوعی که view با Response(content_type=...) می‌گوید حفظ می‌شود وقتی پاسخ در قالب گذاشته می‌شود.
  • PAGE_SIZE_QUERY_PARAM برابر page یا cursor هنگام شروع گزارش می‌شود (drf_parcel.E011): خود paginatorها این دو را می‌خوانند.
  • restock در پروژه‌ی نمونه مقداری را که می‌گیرد اعتبارسنجی می‌کند، و راهنمای قیدهای دیتابیس می‌گوید PostgreSQL کلید خارجی را چه وقت بررسی می‌کند.
  • قرارداد می‌گوید OPTIONS در قالب است، page_size خود view سقف ندارد، و کلید یک DictField که جداکننده‌ی مسیر را دارد مسیر مبهمی می‌سازد.

0.1.0 - ۱۴۰۵/۰۸/۲۳ - اولین نسخه

همه‌ی آنچه قرارداد می‌گوید، ساخته شده.

  • قالب پاسخ - success، status_code، message و data روی هر پاسخ؛ pagination روی لیست صفحه‌بندی‌شده؛ error_code روی خطا. در یک جا ساخته می‌شود، که ساختن قالب غلط را رد می‌کند.
  • پاسخ موفق می‌گوید چه شد - Created، Saved، Deleted یا Done، از روی خود درخواست، و برای یک پاسخ، یک view یا کل پروژه قابل تغییر.
  • EnvelopeMixin پاسخ‌های موفق view را یک بار در قالب می‌گذارد. حذف با 200 همراه با قالب جواب می‌دهد. چیزی که JSON نیست، و viewی که بیرون می‌ماند، دست نمی‌خورد.
  • صفحه‌بندی شماره‌ای یا با cursor، که هر view خودش انتخاب می‌کند. کلاینت فقط جایی تعداد هر صفحه را انتخاب می‌کند که view اجازه بدهد، و همیشه زیر سقف. PAGE_SIZE خود DRF وقتی کتابخانه عددی نگرفته حفظ می‌شود.
  • exception handler هر خطایی را در قالب جواب می‌دهد: خطای اعتبارسنجی با مشکل هر فیلد و کدش در یک مسیر تخت؛ خطاهای DRF و Django با کد استاندارد و هدرهایشان؛ APIException خود پروژه بدون تغییر؛ قیدی که دیتابیس رد می‌کند بر اساس نوعش، وقتی روشن باشد؛ و یک باگ با 500 عمومی که متنش هرگز از سرور بیرون نمی‌رود - لاگ می‌شود، گزارش می‌شود، و در DEBUG بالا می‌رود. هر خطا نوشتن درخواست را برمی‌گرداند.
  • DomainError - همان APIException خود DRF با data - و خطاهای رایج.
  • اسکیما با drf-spectacular: هر پاسخ موفق، صفحه و خطا همان‌طور که به کلاینت می‌رسد.
  • تنظیم DRF_PARCEL کلیدی را که نمی‌شناسد رد می‌کند، و manage.py check مقداری را که کار نمی‌کند گزارش می‌دهد.
  • فارسی، برای هر جمله‌ای که کتابخانه می‌گوید.

پیدا شده در یک بررسی پیش از انتشار، و درست شده:

  • success_response(status_code=204) با 200 و همراه بدنه‌اش جواب می‌دهد، مثل هر 204 دیگری - 204 بدنه ندارد، و کلاینت چیزی نمی‌خواند.
  • PermissionDenied خود Django جمله‌ای را که با آن raise شده نگه می‌دارد، همان‌طور که handler خود DRF نگه می‌دارد.
  • viewی که parcel_wrap = False دارد همان‌طور جواب داده می‌شود که DRF جواب می‌دهد - صفحه‌هایش هم، که هنوز در قالب بودند.
  • ERROR_CODESی که کار نمی‌کند هرگز پاسخ یک خطا را خراب نمی‌کند.
  • اسکیما handler خود پروژه را که روی handler کتابخانه ساخته شده می‌شناسد، و دیگر وقتی drf-spectacular صفحه‌ای را بیرون از یک عملیات نام‌گذاری می‌کند خطا نمی‌دهد.

Python 3.11 تا 3.14؛ Django 5.2، 6.0 و 6.1؛ Django REST framework 3.16 و بالاتر؛ drf-spectacular 0.28 و بالاتر.