REST API
REST API یک API به سبک REST (Representational State Transfer) است: هر مجموعه داده یک منبع با آدرس خودش است، متد HTTP عملیات را تعیین میکند و سرور میان درخواستها وضعیت کلاینت را نگه نمیدارد. روی فیلدینگ این سبک را در رسالهٔ دکترای خود در سال 2000 توصیف کرد.
تفکیک درخواست
درخواست نرخهای فاندینگ BTC در همهٔ صرافیها:
curl "https://api.genesisarbitrage.com/v1/funding/rates?coin=BTC" \
-H "X-API-Key: $GENESIS_API_KEY"
| بخش | مقدار | معنی |
|---|---|---|
| متد | GET | خواندن داده |
| آدرس پایه | https://api.genesisarbitrage.com/v1 | سرور و نسخهٔ API |
| منبع | /funding/rates | نرخهای فاندینگ صرافیها |
| پارامتر | coin=BTC | فقط BTC |
| هدر | X-API-Key | کلید کلاینت |
پاسخ JSON است: data شامل BTC با فهرست صرافیهاست و برای هر کدام نرخ هر بازهٔ فاندینگ (funding_pct) و نرخ نرمالشده به 8 ساعت (funding_8h_pct) آمده است. بدون coin همین منبع همهٔ کوینها را برمیگرداند. فیلدها در بخش نرخهای فاندینگ توضیح داده شدهاند.
متدها و وضعیت
متد به سرور میگوید با منبع چه کند. معنای متدها را استاندارد HTTP، یعنی RFC 9110، تعیین میکند:
GET: دریافت داده؛ متدی ایمن است و روی سرور چیزی را تغییر نمیدهد؛POST: ارسال داده برای پردازش؛ Binance از آن برای ثبت سفارش استفاده میکند (POST /api/v3/order)؛PUT: ساخت یا جایگزینی منبع؛DELETE: حذف؛ Binance از آن برای لغو سفارش استفاده میکند (DELETE /api/v3/order).
Genesis API فقط داده میدهد و همهٔ endpointهایش GET هستند.
بیحالت (stateless) یعنی هر درخواست همهٔ آنچه لازم دارد با خود میبرد: کلید، منبع، فیلترها. سرور درخواستهای قبلی را به خاطر نمیسپارد و GET چیزی را تغییر نمیدهد؛ پس بعد از timeout یا 503 میتوان درخواست را تکرار کرد: نتیجه فقط به خود درخواست و دادههای فعلی بستگی دارد. برای اینکه دادهٔ بدون تغییر دوباره دانلود نشود، Genesis API یک ETag میفرستد: درخواست با If-None-Match در صورت نبودن تغییر 304 میگیرد.
REST در برابر WebSocket
| REST API | WebSocket | |
|---|---|---|
| تعامل | درخواست و پاسخ | جریان پیام در هر دو سو |
| آغازگر | کلاینت | هر طرف، پس از اتصال |
| مناسب برای | عکس لحظهای، فیلتر، تاریخچه | جریان معاملات و دفتر سفارش |
| در Genesis API | همهٔ endpointها | ندارد |
در REST بهروزرسانیها را با polling میگیرید: برنامه درخواست را در بازههای زمانی تکرار میکند. Genesis API خروجیاش را هر meta.freshness_sec ثانیه تازه میکند، از 60 در Trial تا 5 در Max؛ پس polling سریعتر چیزی اضافه نمیکند.
همچنین ببینید: endpoint، WebSocket، قالب پاسخ، درس: اولین درخواست API با HTTP، هدرها و JSON.
پرسش و پاسخ
REST API با API به طور کلی چه فرقی دارد؟
API هر مجموعه قواعدی است که برنامهها با آن با هم حرف میزنند. REST API حالتی مشخص روی HTTP است: منابع با آدرس، متدهای استاندارد و درخواستهایی که به درخواستهای قبلی وابسته نیستند.
REST API در چه قالبی پاسخ میدهد؟
REST قالب را ثابت نمیکند: میتواند JSON، XML یا نوع دیگری باشد. Genesis API با JSON و فشردهسازی gzip پاسخ میدهد.