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

drf-parcel

یک شکل پاسخ برای API ساخته‌شده با Django REST framework - برای پاسخ موفق، صفحه و خطا یکسان - و اسکیمایی که دقیقاً همان شکل را می‌گوید.

{"success": true,  "status_code": 200, "message": "Done.", "data": {"id": 7, "name": "Ring"}}
{"success": false, "status_code": 409, "message": "There is not enough of this product in stock.",
 "data": {"available": 0}, "error_code": "out_of_stock"}

کلاینت فقط یک شکل را می‌خواند و هیچ پاسخی را جداگانه مدیریت نمی‌کند: جواب زیر data است، انسان message را می‌خواند، و کد بر اساس error_code تصمیم می‌گیرد - هرگز بر اساس پیام، که ترجمه می‌شود.

  • همه‌ی پاسخ‌ها در یک قالب - ViewSet، APIView ساده، @action سفارشی، صفحه و خطا یکسان، با پیامی که می‌گوید چه شد.
  • صفحه‌بندی شماره‌ای یا با cursor، که هر view خودش انتخاب می‌کند؛ کلاینت جایی که شما اجازه بدهید تعداد هر صفحه را انتخاب می‌کند، و هرگز بیشتر از سقف نمی‌گیرد.
  • همه‌ی خطاها در همان قالب - مشکل هر فیلد با کدش، خطاهای DRF و Django با کد استاندارد، خطاهای خودتان با dataای که کلاینت بر اساسش کاری می‌کند، و باگی که هرگز اسرارش را نمی‌گوید.
  • اسکیما همان چیزی را می‌گوید که می‌رسد - drf-spectacular خود قالب را مستند می‌کند، نه فقط داخلش را، پس کلاینت ساخته‌شده response.data.id می‌خواند.

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

نصب

pip install 'drf-parcel[schema]'
INSTALLED_APPS = [..., 'rest_framework', 'drf_parcel']

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'drf_parcel.handlers.exception_handler',
    'DEFAULT_PAGINATION_CLASS': 'drf_parcel.pagination.PageNumberPagination',
    'DEFAULT_SCHEMA_CLASS': 'drf_parcel.schema.ParcelAutoSchema',
}

قدم بعد

شروع سریع اولین view در قالب، در پنج دقیقه
آموزش فروشگاه نمونه، بخش به بخش ساخته می‌شود
راهنماهای کاربردی یک سؤال که پروژه با آن روبه‌رو می‌شود، در چند قدم - اول از همه به کار گرفتن در یک پروژه‌ی موجود
قرارداد هر شکل، هر کد خطا، هر تنظیم - آنچه کد قول می‌دهد
مرجع تنظیمات، کدهای خطا، بررسی‌های هنگام start، و API پایتون
توضیح‌ها چرا این‌طور ساخته شده، و چه فرقی با بقیه دارد
پرسش‌ها آنچه اول از همه پرسیده می‌شود
فروشگاه نمونه پروژه‌ای که همه‌ی آن را به کار می‌برد، برای اجرا

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