رفتن به محتوا
دانشیارمستندات
ورود
  • ویجت جاسازی‌شدهدر نقشهٔ راه: به‌زودی
  • SDK برای TypeScriptدر نقشهٔ راه: به‌زودی
  1. مستندات
  2. یکپارچه‌سازی
  3. SDK برای TypeScript

SDK برای TypeScript

در نقشهٔ راه: به‌زودی

یک کلاینت تایپ‌دار برای این API. هنوز در دسترس نیست.

وضعیت

هنوز هیچ SDK مخصوص TypeScript وجود ندارد. بسته‌ای منتشر نشده و هیچ چیزی در این مخزن آن را پیاده‌سازی نکرده است.

هر چیزی که SDK قرار بود بپوشاند امروز روی HTTP ساده در دسترس است، و نمونه‌های سراسر این مستندات از چیزی جز fetch داخلی استفاده نمی‌کنند. اگر همین حالا کلاینت تایپ‌دار می‌خواهید، سریع‌ترین راه نوشتن یک لایهٔ نازک دور مسیرهای این مرجع است — سطح API آن‌قدر کوچک هست که تولید کلاینت از روی OpenAPI schema هم منطقی باشد.

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

شکل پیش‌بینی‌شده

شکلی که در نظر بوده، اگر برای ساختاردهی به لایهٔ خودتان کمکتان می‌کند: یک سازندهٔ کلاینت که کلید را نگه می‌دارد، برای هر بخش از API یک فضای نام، و پاسخ‌های تایپ‌داری که پوشش را باز می‌کنند تا فراخوان هرگز خودش با data سروکار نداشته باشد.

همچنین دو شکل خطا را به یک خطای تایپ‌دار یکسان تبدیل می‌کرد، مهلت زمانی و سیاست تلاش دوباره — فقط برای 5xx — داشت، و AbortSignal می‌پذیرفت؛ همان چهار چیزی که هر لایهٔ دست‌نویسی سرانجام به آن‌ها نیاز پیدا می‌کند.

چه چیزی مانع است

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

قبلیویجت جاسازی‌شده

در این صفحه

  • وضعیت
  • شکل پیش‌بینی‌شده
  • چه چیزی مانع است

همهٔ نمونه‌های این مستندات روی API واقعی اجرا می‌شوند. اگر نمونه‌ای کار نکرد، به ما بگویید؛ آن یک باگ در مستندات است.

گفت‌وگو با ما