پرش به مطلب اصلی

استاندارد Response

در پروژه‌های مبتنی بر دُراول، response باید از ساختار مشترک پروژه عبور کند.

قوانین

  • استفاده از response macro الزامی است
  • raw json() response در controller ممنوع است
  • error و success باید ساختار قابل پیش‌بینی داشته باشند
  • pagination باید ساختار استاندارد داشته باشد
  • شناسه‌های حساس در صورت policy پروژه باید encrypted باشند

Pagination

response صفحه‌بندی باید شامل داده و metadata لازم باشد:

  • items
  • current page
  • per page
  • total
  • links در صورت نیاز

موارد ممنوع

  • ساختار response متفاوت برای endpointهای مشابه
  • return کردن exception message خام
  • expose کردن id یا field حساس برخلاف policy