REST API
REST API REST शैली (Representational State Transfer) में बना API है: हर डेटा सेट अपने URL वाला एक resource है, HTTP मेथड कार्रवाई तय करता है, और सर्वर request के बीच क्लाइंट की स्थिति नहीं रखता। Roy Fielding ने इस शैली का वर्णन 2000 में अपने डॉक्टरेट शोधग्रंथ में किया था।
Request का विश्लेषण
सभी एक्सचेंज पर BTC की funding rate की request:
curl "https://api.genesisarbitrage.com/v1/funding/rates?coin=BTC" \
-H "X-API-Key: $GENESIS_API_KEY"
| हिस्सा | मान | मतलब |
|---|---|---|
| मेथड | GET | डेटा पढ़ना |
| बेस URL | https://api.genesisarbitrage.com/v1 | सर्वर और API का संस्करण |
| Resource | /funding/rates | एक्सचेंज की funding rate |
| पैरामीटर | coin=BTC | सिर्फ़ BTC |
| हेडर | X-API-Key | क्लाइंट की key |
जवाब JSON है: data में BTC और एक्सचेंज की सूची है, हर एक्सचेंज के लिए funding अंतराल की दर (funding_pct) और 8 घंटे में बदली दर (funding_8h_pct) के साथ। coin के बिना यही resource सारे कॉइन लौटाता है। फ़ील्ड Funding rates सेक्शन में बताए गए हैं।
मेथड और स्टेट
मेथड सर्वर को बताता है कि resource के साथ क्या करना है। मेथड का अर्थ HTTP मानक, RFC 9110, तय करता है:
GET: डेटा लेना; मेथड सुरक्षित है और सर्वर पर कुछ नहीं बदलता;POST: प्रोसेसिंग के लिए डेटा भेजना; Binance इससे ऑर्डर लगाता है (POST /api/v3/order);PUT: resource बनाना या बदलना;DELETE: हटाना; Binance इससे ऑर्डर रद्द करता है (DELETE /api/v3/order)।
Genesis API सिर्फ़ डेटा देता है, इसलिए उसके सारे endpoint GET हैं।
Stateless का मतलब है कि हर request में वह सब है जो उसे चाहिए: key, resource, फ़िल्टर। सर्वर पिछली calls याद नहीं रखता और GET कुछ नहीं बदलता, इसलिए timeout या 503 के बाद request दोहराई जा सकती है: नतीजा सिर्फ़ request और मौजूदा डेटा पर निर्भर है। बिना बदला डेटा दोबारा डाउनलोड न हो, इसके लिए Genesis API ETag भेजता है: If-None-Match वाली request को कुछ न बदलने पर 304 मिलता है।
REST बनाम WebSocket
| REST API | WebSocket | |
|---|---|---|
| संवाद | request और जवाब | दोनों तरफ़ संदेशों की धारा |
| शुरुआत कौन करता है | क्लाइंट | कनेक्ट होने के बाद कोई भी पक्ष |
| किसके लिए ठीक | स्नैपशॉट, फ़िल्टर, इतिहास | ट्रेड और order book फ़ीड |
| Genesis API में | सारे endpoint | नहीं |
REST में अपडेट polling से मिलते हैं: प्रोग्राम तय अंतराल पर request दोहराता है। Genesis API अपना आउटपुट हर meta.freshness_sec सेकंड में ताज़ा करता है, Trial में 60 से Max में 5 तक, इसलिए इससे तेज़ polling से कुछ नहीं मिलता।
यह भी देखें: endpoint, WebSocket, रिस्पॉन्स फ़ॉर्मेट, पाठ: HTTP, हेडर और JSON के साथ आपकी पहली API request।
सवाल और जवाब
REST API आम API से कैसे अलग है?
API वह कोई भी नियम-सेट है जिससे प्रोग्राम आपस में बात करते हैं। REST API HTTP पर उसका एक ख़ास रूप है: URL पर resource, मानक मेथड और ऐसी request जो पिछली request पर निर्भर नहीं करतीं।
REST API किस फ़ॉर्मेट में जवाब देता है?
REST फ़ॉर्मेट तय नहीं करता: JSON, XML या कुछ और हो सकता है। Genesis API gzip कम्प्रेशन के साथ JSON में जवाब देता है।