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

چرا یک قالب

DRF یک لیست را به شکل آرایه‌ی خالی جواب می‌دهد، یک صفحه را با count/next/results، یک شیء را خودش، خطای اعتبارسنجی را دیکشنری‌ای از فیلدها، و هر خطای دیگری را {"detail": ...}. کلاینت پنج شکل را مدیریت می‌کند، و برای فهمیدن اینکه کدام را گرفته به محتوا نگاه می‌کند.

یک قالب این‌ها را یک شکل می‌کند، که با یک کلید تشخیص داده می‌شود نه با حدس:

{"success": true,  "status_code": 200, "message": "...", "data": ...}
{"success": false, "status_code": 409, "message": "...", "data": {...}, "error_code": "..."}

هر کلید برای کسی است

کلید برای چرا هست
success کد یک مقدار بولی برای تصمیم گرفتن، پیش از خواندن هر چیز دیگر
status_code کد، و لاگ‌ها وضعیت از پروکسی، کش یا کلاینتی که آن را دور بریزد جان سالم به در می‌برد
message انسان یک جمله، به زبان خواننده - یک toast، یک هشدار
data کد جواب: یک شیء، یک لیست، یا {} - هرگز null
pagination صفحه‌بند فقط روی لیست صفحه‌بندی‌شده: کلیدی که نیست هم چیزی می‌گوید
error_code کد فقط روی خطا: چیزی که کلاینت بر اساسش تصمیم می‌گیرد، که با بازنویسی پیام ثابت می‌ماند

یک کلید یا همیشه هست، یا به دلیلی هست. pagination خالی روی لیستی که صفحه‌بندی ندارد قول صفحه‌هایی است که هرگز نمی‌آیند؛ error_code روی پاسخ موفق کدی برای هیچ چیز است.

پیام، کد نیست

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

هزینه

کلاینت response.data.id می‌خواند، نه response.id - در هر پاسخ یک سطح عمیق‌تر. اسکیما این را می‌گوید، پس کلاینت ساخته‌شده آن را درست می‌گیرد؛ کلاینت دست‌نوشته یک بار یادش می‌گیرد. در عوض، مدیریت خطا، صفحه‌بندی و پیام‌ها یک بار نوشته می‌شوند، برای همه‌ی endpointها.