به محتوای اصلی

خروجی‌ها و SDK

مستندات پروژه فقط صفحهٔ خواندنی نیست؛ چند خروجی آماده دارد که مستقیم داخل ابزار و کد شما می‌نشینند. همه از صفحهٔ «مستندات API» هر پروژه دانلود می‌شوند و بعد از هر تغییر مدل داده، خودکار به‌روزند.

Postman

یک بستهٔ zip شامل کالکشن کامل اندپوینت‌ها به‌همراه دو environment آماده: Production و Local. کلید اصلی پروژه از قبل داخلشان گذاشته شده؛ کافی است در Postman ایمپورت کنید و درخواست بفرستید.

Bruno

همان کالکشن برای Bruno — جایگزین متن‌باز و آفلاین Postman که فایل‌هایش کنار کد در گیت نگه‌داری می‌شود. کلید اصلی پروژه این‌جا هم از قبل در environmentها هست.

کتابخانهٔ کلاینت (SDK)

کلاینت تایپ‌شده از روی مدل دادهٔ پروژه تولید می‌شود — مدل‌ها، فهرست با فیلتر و صفحه‌بندی، و ورود و ثبت‌نام کاربران:

  • Flutter (Dart)
  • Kotlin
  • Swift

برای وب، Node و ری‌اکت‌نیتیو کلاینت جداگانه‌ای روی npm منتشر شده که تولیدشده نیست و نصب می‌شود — تفاوتش این است که با تغییر اسکیما لازم نیست دوباره دانلودش کنید، ولی مدل‌ها را هم خودکار تایپ نمی‌کند:

SDK از روی اسکیمای لحظهٔ دانلود ساخته می‌شود. هر بار مدل داده را تغییر دادید و اعمال کردید، نسخهٔ تازه را بگیرید تا تایپ‌ها هماهنگ بمانند.

تحویل به دولوپر

اگر توسعهٔ اپ را کس دیگری انجام می‌دهد، این بسته همان چیزی است که تحویلش می‌دهید: مستندات اندپوینت‌ها + کالکشن Postman + کلید اصلی پروژه. دولوپر بدون هیچ توضیح اضافه‌ای می‌تواند شروع کند.

بیشتر بخوانید

  • Backend as a Service ایرانی — خروجی کامل داده چه چیزی را تضمین می‌کند و مهاجرت از Firebase در عمل چه شکلی است.