इस दस्तावेज़ में कुछ ऐसी तकनीकें बताई गई हैं जिनका इस्तेमाल करके, अपने ऐप्लिकेशन की परफ़ॉर्मेंस को बेहतर बनाया जा सकता है. कुछ मामलों में, अन्य एपीआई या सामान्य एपीआई के उदाहरणों का इस्तेमाल, दिखाए गए आइडिया को दिखाने के लिए किया जाता है. हालांकि, यही सिद्धांत Android Over The Air API पर भी लागू होते हैं.
gzip का इस्तेमाल करके कंप्रेस करना
हर अनुरोध के लिए ज़रूरी बैंडविड्थ को कम करने का एक आसान और आसान तरीका, gzip संपीड़न को चालू करना है. हालांकि, नतीजों को असंपीड़ित करने के लिए सीपीयू (CPU) में ज़्यादा समय लग सकता है, लेकिन आम तौर पर नेटवर्क की लागत कम करना फ़ायदेमंद साबित होता है.
gzip-एन्कोडेड रिस्पॉन्स पाने के लिए आपको दो काम करने होंगे: Accept-Encoding
हेडर सेट करें और gzip
स्ट्रिंग को शामिल करने के लिए अपने उपयोगकर्ता एजेंट में बदलाव करें. gzip कंप्रेशन को चालू करने के लिए, सही तरीके से बनाए गए एचटीटीपी हेडर का उदाहरण यहां दिया गया है:
Accept-Encoding: gzip User-Agent: my program (gzip)
आंशिक संसाधनों के साथ काम करना
एपीआई कॉल की परफ़ॉर्मेंस को बेहतर बनाने का एक और तरीका है, डेटा का सिर्फ़ वही हिस्सा भेजना और पाना जिसमें आपकी दिलचस्पी है. यह आपके ऐप्लिकेशन को ग़ैर-ज़रूरी फ़ील्ड को ट्रांसफ़र करने, पार्स करने, और स्टोर करने से बचाता है, ताकि वह नेटवर्क, सीपीयू, और मेमोरी जैसे संसाधनों का बेहतर तरीके से इस्तेमाल कर सके.
अधूरे अनुरोध दो तरह के होते हैं:
- अधूरे जवाब: वह अनुरोध जहां आप तय करते हैं कि जवाब में किन फ़ील्ड को शामिल करना है (
fields
अनुरोध पैरामीटर का इस्तेमाल करें). - पैच: अपडेट करने का अनुरोध, जिसमें सिर्फ़ बदलाव किए जाने वाले फ़ील्ड भेजे जाते हैं. इसके लिए,
PATCH
एचटीटीपी कार्रवाई का इस्तेमाल करें.
आंशिक अनुरोधों के बारे में ज़्यादा जानकारी नीचे दिए गए सेक्शन में दी गई है.
अधूरे जवाब
डिफ़ॉल्ट रूप से, अनुरोधों को प्रोसेस करने के बाद सर्वर, संसाधन को पूरी तरह से दिखाता है. बेहतर परफ़ॉर्मेंस के लिए, सर्वर को सिर्फ़ उन फ़ील्ड को भेजने के लिए कहा जा सकता है जिनकी आपको वाकई ज़रूरत है. इसके बाद, सर्वर को पार्शियल रिस्पॉन्स मिलेगा.
अधूरे जवाब का अनुरोध करने के लिए, fields
अनुरोध पैरामीटर का इस्तेमाल करके, उन फ़ील्ड की जानकारी दें जिन्हें आपको दिखाना है. इस पैरामीटर का इस्तेमाल, रिस्पॉन्स का डेटा दिखाने वाले किसी भी अनुरोध के साथ किया जा सकता है.
ध्यान दें कि fields
पैरामीटर सिर्फ़ रिस्पॉन्स डेटा पर असर डालता है. अगर कोई डेटा भेजा जाए, तो इससे उस पर कोई असर नहीं पड़ता. संसाधनों में बदलाव करते समय भेजे जाने वाले डेटा की मात्रा को कम करने के लिए, पैच अनुरोध का इस्तेमाल करें.
उदाहरण
पैच (आंशिक अपडेट)
संसाधनों में बदलाव करते समय ग़ैर-ज़रूरी डेटा भेजने से भी बचा जा सकता है. सिर्फ़ उन खास फ़ील्ड के लिए अपडेट किया गया डेटा भेजने के लिए जिन्हें बदला जा रहा है, एचटीटीपी PATCH
क्रिया का इस्तेमाल करें. इस दस्तावेज़ में बताए गए पैच सिमैंटिक, आंशिक अपडेट के GData को लागू करने वाले पुराने वर्शन से अलग (और आसान) हैं.
नीचे दिया गया उदाहरण दिखाता है कि पैच का इस्तेमाल करने से, छोटा सा अपडेट करने के लिए भेजे जाने वाले डेटा को कैसे कम किया जाता है.
उदाहरण
किसी पैच का रिस्पॉन्स मैनेज करना
पैच के मान्य अनुरोध को प्रोसेस करने के बाद, एपीआई, बदले गए संसाधन की पूरी जानकारी के साथ एक 200 OK
एचटीटीपी रिस्पॉन्स कोड दिखाता है. अगर एपीआई, ETag का इस्तेमाल करता है, तो सर्वर, पैच के अनुरोध को प्रोसेस करने पर ETag की वैल्यू अपडेट कर देता है. ठीक उसी तरह, जिस तरह PUT
के साथ भी ETag इस्तेमाल किए जाते हैं.
पैच अनुरोध की वजह से, पूरे संसाधन की जानकारी तब तक मिलती है, जब तक कि इसे कम करने के लिए fields
पैरामीटर का इस्तेमाल नहीं किया जाता.
अगर पैच अनुरोध के नतीजे के तौर पर, संसाधन की ऐसी नई स्थिति मिलती है जो वाक्य के हिसाब से या किसी शब्द के हिसाब से गलत है, तो सर्वर 400 Bad Request
या 422 Unprocessable Entity
एचटीटीपी स्टेटस कोड दिखाता है. साथ ही, संसाधन की स्थिति में कोई बदलाव नहीं होता. उदाहरण के लिए, अगर किसी ज़रूरी फ़ील्ड की वैल्यू मिटाने की कोशिश की जाती है, तो सर्वर गड़बड़ी वाला मैसेज दिखाता है.
पैच एचटीटीपी कार्रवाई के काम न करने पर वैकल्पिक नोटेशन
अगर आपका फ़ायरवॉल एचटीटीपी PATCH
अनुरोधों की अनुमति नहीं देता है, तो एचटीटीपी POST
अनुरोध करें और ओवरराइड हेडर को PATCH
पर सेट करें, जैसा कि यहां दिखाया गया है:
POST https://www.googleapis.com/... X-HTTP-Method-Override: PATCH ...
पैच और अपडेट में अंतर
असल में, जब एचटीटीपी PUT
वर्ब का इस्तेमाल करने वाले अपडेट के अनुरोध के लिए डेटा भेजा जाता है, तो आपको सिर्फ़ उन फ़ील्ड को भेजना ज़रूरी है जो या तो ज़रूरी हैं या वैकल्पिक हैं; अगर सर्वर से सेट की गई फ़ील्ड के लिए वैल्यू भेजी जाती हैं, तो उन्हें अनदेखा कर दिया जाता है. हालांकि, यह तरीका कुछ हद तक अपडेट करने का अन्य तरीका लग सकता है, लेकिन इस तरीके की कुछ सीमाएं हैं. एचटीटीपी PUT
क्रिया का इस्तेमाल करने वाले अपडेट के साथ, ज़रूरी पैरामीटर न देने पर अनुरोध काम नहीं करता. साथ ही, वैकल्पिक पैरामीटर न देने पर, पहले से सेट किया गया डेटा मिटा दिया जाता है.
इसी वजह से पैच का इस्तेमाल करना ज़्यादा सुरक्षित होता है. सिर्फ़ उन फ़ील्ड का डेटा दिया जाता है जिन्हें बदलना है. जिन फ़ील्ड को छोड़ना है उन्हें नहीं मिटाया जाता. इस नियम का अपवाद सिर्फ़ दोहराए जाने वाले एलिमेंट या अरे के साथ होता है: अगर आप सभी को छोड़ देते हैं, तो वे वैसे ही बने रहते हैं; अगर आप उनमें से कोई भी देते हैं, तो पूरे सेट को आपके दिए गए सेट से बदल दिया जाता है.