۴. اسکیما و زبانها¶
اسکیما همان چیزی را میگوید که میرسد¶
drf-spectacular serializerها را میخواند، پس بهتنهایی آنچه را داخل قالب
است مستند میکند - و کلاینتی که از آن ساخته شود response.id مینویسد، در
حالی که حقیقت response.data.id است. ParcelAutoSchema خود قالب را مستند
میکند. http://127.0.0.1:8000/api/docs/ را باز کنید:
- هر پاسخ موفق viewی که mixin دارد همان قالب است، با
dataهمان serializer - و حذف همان 200ی که جواب میدهد؛ - هر صفحه component خودش را دارد، با اسمی که نوعش را میگوید -
ProductPage،OrderCursorPage؛ page_sizeروی محصولات آمده، با سقفش بهعنوان maximum، و روی سفارشها نه؛- پاسخ
defaultهر عملیاتErrorEnvelopeاست، و عملیاتی که بدنه میگیردValidationErrorEnvelopeرا بهعنوان 400 دارد.
viewی که بیرون از قالب مانده همانطور که جواب میدهد مستند میشود:
example/shop/api.py
class HealthView(EnvelopeMixin, APIView):
"""Asked by a load balancer that expects {"ok": true} - so it stays out of the envelope."""
parcel_wrap = False
@extend_schema(responses=inline_serializer('Health', fields={'ok': serializers.BooleanField()}))
def get(self, request: Request) -> Response:
return Response({'ok': True})
جواب به فارسی¶
با LocaleMiddleware، زبان مال درخواست است:
هر جملهای که کتابخانه میگوید به فارسی هم هست. جملههای خود DRF - «This field
is required.» - به زبانهایی است که DRF دارد. پیامهای خودتان، که با
gettext_lazy علامت خوردهاند، در کاتالوگ پروژهی خودتان ترجمه میشوند.
کلیدها، کدها و داده عوض نمیشوند: فقط آنچه انسان میخواند عوض میشود.
از اینجا به کجا¶
- راهنماهای کاربردی - به کار گرفتن در یک پروژهی موجود، خواندن قالب از فرانت، تست.
- قرارداد - همهی شکلها و کدها.