API उबदार

वास्तविक पद्धती, शीर्षलेख, कुकीज, मुख्य भाग आणि कॉन्फिगरेशन मॅट्रिकसह REST आणि GraphQL एंडपॉइंट्स गरम ठेवा.

13 min read

APIs अगदी वेब पृष्ठांप्रमाणे थंड होतात. जर JSON प्रतिसाद तयार करणे महाग असेल आणि तुमच्या CDN किंवा गेटवेवर कॅश केले असेल, तर कालबाह्य झाल्यानंतर पहिला क्लायंट वेबसाइट अभ्यागताला समान दंड भरतो.

API वॉर्मर्स ते सोडवतात. खाते → API वॉर्मर्स अंतर्गत, वेबसाइट वॉर्मर्सपासून ते स्वतंत्रपणे व्यवस्थापित केले जातात आणि त्यांच्या स्वतःच्या योजना मर्यादा आहेत.

वेबसाइट वॉर्मर्सपासून वेगळे करा

API वॉर्मर्स हे त्यांच्या स्वतःच्या हक्कासह एक वेगळे वैशिष्ट्य आहे. विभाग गहाळ किंवा लॉक केलेला असल्यास, तुमच्या योजनेत त्यांचा समावेश नाही — पहा योजना आणि मर्यादा.

कधी वापरायचे

परिस्थितीAPI उबदार का मदत करते
हेडलेस स्टोअरफ्रंट किंवा साइटउत्पादन, इन्व्हेंटरी आणि सामग्री JSON प्रत्येक पृष्ठ प्रस्तुतीवर प्राप्त केली जाते. त्या मार्गांना उबदार केल्याने संपूर्ण पुढचे टोक जलद राहते.
सार्वजनिक विकसक APIलोकप्रिय एंडपॉइंट आणि दस्तऐवजीकरण उदाहरणे प्रथम कॉल करणाऱ्यासाठी हळू होण्याऐवजी प्रतिसादात्मक राहतात.
फ्रंटएंडसाठी बॅकएंड लेयरएकत्रित एंडपॉइंट्स जे अनेक सेवांना पसंत करतात ते पुनर्बांधणीसाठी महाग असतात. त्यांना गरम करणे मोबाइल आणि वेब क्लायंटचे संरक्षण करते.
भारी GraphQL ऑपरेशन्सकाही प्रश्न सामान्यतः रहदारीवर वर्चस्व गाजवतात. /graphql एकदा मारण्यापेक्षा त्या विशिष्ट ऑपरेशन्सला उबदार करणे अधिक महत्त्वाचे आहे.

API वॉर्मर एंडपॉइंट्ससाठी उपयुक्त नाही जे कधीही कॅश केलेले नाहीत किंवा जे प्रति वापरकर्ता अद्वितीय आहेत आणि म्हणून भरण्यासाठी सामायिक केलेली कॅशे प्रत नाही.

API उबदार तयार करणे

  1. 1

    API होस्टनाव सत्यापित करा

    एंडपॉईंट URLs सत्यापित होस्टनाव वापरणे आवश्यक आहे, अगदी वेबसाइट वॉर्मर्स प्रमाणे. पहा होस्टनाव पडताळणी.

  2. 2

    वॉर्मरला नाव द्या आणि त्याला निष्क्रिय सोडा

    प्रथम कॉन्फिगर करा, जेव्हा तुम्ही समाधानी असाल तेव्हा सक्रिय करा.

  3. 3

    एक किंवा अधिक अंतिम बिंदू जोडा

    प्रत्येक एंडपॉइंटमध्ये URL आणि HTTP पद्धत आणि वैकल्पिकरित्या लेबल, मुख्य भाग आणि सामग्री प्रकार असतो.

  4. 4

    एंडपॉइंटला आवश्यक असल्यास प्रमाणीकरण जोडा

    वॉर्मरने केलेल्या प्रत्येक विनंतीवर ग्लोबल शीर्षलेख आणि कुकीज लागू केल्या जातात.

  5. 5

    वैकल्पिकरित्या कॉन्फिगरेशन मॅट्रिक्ससह विस्तृत करा

    डझनभर जवळपास एकसारखे वॉर्मर तयार न करता — लोकॅल, भाडेकरू, आयडी — अनेक प्रकार कव्हर करा.

  6. 6

    दर आणि अंतराल सेट करा, नंतर सक्रिय करा

    वेबसाइट वॉर्मर्स सारखीच कल्पना: तुमची कॅशे TTL मारण्यासाठी पुरेशी उबदार, हळूहळू दुखापत होणार नाही.

अंत्यबिंदू

वॉर्मरमधील प्रत्येक शेवटचा बिंदू स्वतंत्रपणे कॉन्फिगर केला आहे:

लेबल
मानवी-वाचण्यायोग्य पर्यायी नाव, त्यामुळे अंतिम बिंदूंची एक लांबलचक यादी वाचनीय राहते.
WordPress
सत्यापित होस्टनावावर पूर्ण एंडपॉइंट पत्ता. PATH डायमेंशनसह जोडल्यास {id} किंवा :id सारखे पथ प्लेसहोल्डर असू शकतात.
पद्धत
GET, POST आणि इतर तुमच्या योजनेनुसार. प्लॅन्स सामान्यतः GET आणि HEAD ला डीफॉल्टनुसार परवानगी देतात, उच्च स्तरांवर अधिक पद्धतींसह.
प्रोटोकॉल
REST किंवा GRAPHQL. GraphQL निवडल्याने ऑपरेशन आणि क्वेरी फील्ड उघड होतात.
शरीर टेम्पलेटची विनंती करा
पाठवायचे मुख्य भाग, एक घेऊन जाणाऱ्या पद्धतींसाठी. API विनंती मुख्य भाग पात्रता आवश्यक आहे.
WordPress
विनंती मुख्य भागाचा सामग्री प्रकार, विशेषत: application/json.
निर्विकार
एंडपॉईंटला दोनदा कॉल करण्यासाठी सुरक्षित म्हणून चिन्हांकित करते, थंड/उबदार दुहेरी फेच सक्षम करते जे सुधारणा मोजते. दोनदा कॉल केल्यावर कोणतेही दुष्परिणाम नसतात तेव्हाच ते सक्षम करा.
सक्षम केले
हा विशिष्ट एंडपॉइंट धावांमध्ये समाविष्ट केला आहे की नाही. एक एंडपॉइंट न हटवता तात्पुरते अक्षम करण्यासाठी उपयुक्त.

लेखन ऑपरेशन्स इम्पोटेंट चिन्हांकित करताना सावधगिरी बाळगा

ऑर्डर तयार करणाऱ्या, ईमेल पाठवणाऱ्या किंवा चार्जेस कार्ड्स तयार करणाऱ्या एंडपॉइंटवर दुहेरी आणणे हे दोनदा करेल. पुनरावृत्ती केल्यावर केवळ एंडपॉइंट इडम्पोटंट म्हणून चिन्हांकित करा ते खरोखर निरुपद्रवी आहे.

कॉन्फिग मॅट्रिक्स

बऱ्याच API चे रूपे असतात: प्रति लोकॅल, प्रति भाडेकरू, प्रति चलन किंवा प्रति आयडी नावाचा समान अंतबिंदू. प्रत्येकासाठी वॉर्मर तयार करणे अशक्य आहे.

कॉन्फिगरेशन मॅट्रिक्स याचे निराकरण करते. तुम्ही अनेक मूल्यांसह परिमाण परिभाषित करता आणि Cache Rocket संपूर्ण कार्टेशियन उत्पादनाचा वैयक्तिक उबदार विनंत्यांमध्ये विस्तार करते.

परिमाण प्रकारमध्ये मूल्ये इंजेक्ट करतेउदाहरण
WordPressक्वेरी स्ट्रिंग/cart, /checkout, /my-account
WordPressविनंती शीर्षलेखX-Tenant: acme, X-Tenant: globex
WordPressएक कुकीX-Tenant: acme, X-Tenant: globex
WordPressURL मध्ये A {placeholder}{id}1, 2, 3

काम केलेले उदाहरण

text
Endpoint:  GET https://api.example.com/v1/products/{category}

Dimensions:
  PATH   category = shoes, bags, hats
  QUERY  locale   = en, nl

Expands to 6 warm requests:
  /v1/products/shoes?locale=en
  /v1/products/shoes?locale=nl
  /v1/products/bags?locale=en
  /v1/products/bags?locale=nl
  /v1/products/hats?locale=en
  /v1/products/hats?locale=nl

संयोजन जलद गुणाकार

एकूण विनंत्या प्रत्येक परिमाणाच्या मूल्याच्या संख्येचे उत्पादन आहेत. प्रत्येकी पाच मूल्यांची तीन मिती म्हणजे एकाच टोकापासून 125 संयोग. फॉर्म चालू संख्या आणि तुमच्या योजनेची कमाल दर्शवितो — तुम्ही मूल्ये जोडता तेव्हा ते पहा.

आपण योजनेची कमाल मर्यादा ओलांडल्यास, वॉर्मर वाचणार नाही. मूल्ये कमी करा, अनेक वॉर्मर्समध्ये विभाजित करा किंवा अपग्रेड करा.

प्रमाणीकरण

ग्लोबल विनंती शीर्षलेख आणि कुकीज प्रत्येक वेरिएंटवर लागू केले जातात जे वॉर्मर तयार करतात. येथे Authorization शीर्षलेख किंवा सत्र कुकी जाते.

ठराविक प्रमाणीकरण शीर्षलेख
text
Authorization: Bearer YOUR_LONG_LIVED_TOKEN
X-Api-Key: YOUR_API_KEY

वास्तविक ग्राहकांनी विनंती केलेल्या व्हेरिएंटला उबदार करा

तुमची कॅशे Authorization ने बदलत असल्यास, सर्व्हिस टोकनसह वार्मिंग केल्याने त्या टोकनवर की असलेली कॅशे एंट्री भरते — ज्याला कोणताही खरा क्लायंट कधीही मारणार नाही. सामायिक, कॅशे करण्यायोग्य प्रतिसादांसाठी, सामान्य क्लायंट ज्या प्रकारे एंडपॉइंटला कॉल करतो त्याच प्रकारे उबदार.

टोकन कालबाह्य होतात. जर API वॉर्मर अचानक 401 परत येऊ लागला, तर हार्ड-कोडेड टोकन हे तपासण्याची पहिली गोष्ट आहे.

WordPress

GraphQL ला त्याच्या स्वतःच्या उपचारांची आवश्यकता आहे कारण कार्यप्रदर्शन विशिष्ट ऑपरेशनवर अवलंबून असते, अंतिम बिंदू मार्गावर नाही. एकदा /graphql मारल्याने तुम्हाला काहीच कळत नाही; तुमच्या तीन जड क्वेरींना वार्मिंग केल्याने तुम्हाला सर्व काही सांगते.

एंडपॉइंटचा प्रोटोकॉल GraphQL वर सेट करा, नंतर पुरवठा करा:

  • GraphQL ऑपरेशन — हे query किंवा mutation असो. तापमानवाढ उत्परिवर्तन जवळजवळ कधीही योग्य नसते.
  • GraphQL क्वेरी — पाठवायचे ऑपरेशन दस्तऐवज.
  • व्हेरिएबल्स — त्यांना विनंती बॉडी टेम्प्लेटद्वारे किंवा अनेक व्हेरिएबल सेट उबदार करण्यासाठी मॅट्रिक्स डायमेंशन व्हॅल्यू म्हणून पुरवा.

Note

GraphQL वार्मिंग API वॉर्मर्सच्या वर, त्याच्या स्वतःच्या प्लॅन एंटाइटलमेंटद्वारे गेट केले जाते.

OpenAPI आयात

सपोर्ट केलेल्या प्लॅन्सवर तुम्ही ओपनएपीआय 3 स्पेसिफिकेशनमधून एंडपॉइंट इंपोर्ट करू शकता त्याऐवजी ते टाइप करा. JSON किंवा YAML स्पेकचे URL पेस्ट करा आणि इम्पोर्ट वर क्लिक करा; शोधलेले एंडपॉइंट्स वॉर्मरमध्ये जोडले जातात, छाटणी आणि समायोजित करण्यासाठी तयार असतात.

Tip

आयात लेखन ऑपरेशन्ससह वर्णन केलेल्या सर्व गोष्टी आणते. सूचीचे काळजीपूर्वक पुनरावलोकन करा आणि सक्रिय करण्यापूर्वी शेड्यूलमध्ये कॉल करू नये अशी कोणतीही गोष्ट अक्षम करा.

मर्यादा आणि वेळापत्रक

कमाल तापमान प्रति मिनिट
या API वॉर्मरसाठी कमाल मर्यादा, वेबसाइटवर कमाल URLs प्रति मिनिट वॉर्मरच्या समतुल्य.
विनंती कालबाह्य
हार मानण्यापूर्वी प्रतिसादाची किती प्रतीक्षा करावी.
स्वयं प्रारंभ मध्यांतर
किती वेळा नवीन उबदार पास सुरू होतो, काही सेकंदात.
रांगेत मध्यांतर
सायकलमध्ये पुन्हा रांगेत लावलेल्या कामाचे पेसिंग.
HTTPS वर पुन्हा लिहा
http:// एंडपॉइंट URLs https:// वर श्रेणीसुधारित करा.
उबदार वेळापत्रक
पीक आणि ऑफ-पीक विंडो, वेबसाइट वॉर्मर्स प्रमाणेच JSON फॉरमॅट. पहा प्रगत तापमानवाढ.

तुमची योजना API वॉर्मर्सची संख्या, प्रति वॉर्मर एंडपॉइंट्स आणि प्रति वॉर्मर कॉम्बिनेशन्स देखील कॅप करते.

सामान्य समस्या

सर्व काही 401 किंवा 403 परत करते.
प्रमाणीकरण शीर्षलेख किंवा कुकी गहाळ आहे, चुकीची आहे किंवा कालबाह्य झाली आहे. दीर्घकाळ टिकणारे टोकन हे नेहमीचे अपराधी असतात — टोकन अद्याप वैध आहे आणि फिरवलेले नाही ते तपासा.
बर्याच संयोगांचा हवाला देऊन, वॉर्मर जतन करणार नाही.
तुमचे मॅट्रिक्स जास्तीत जास्त प्लॅनच्या पलीकडे विस्तारते. परिमाण मूल्ये कमी करा, अनेक वॉर्मर्समध्ये अंतिम बिंदू विभाजित करा किंवा अपग्रेड करा.
मला आवश्यक असलेली पद्धत ड्रॉपडाउनमध्ये नाही.
कोणत्या HTTP पद्धतींना अनुमती आहे हे योजना प्रतिबंधित करतात. खालच्या स्तरांना सामान्यत: फक्त GET आणि HEAD परवानगी मिळते.
वार्मिंग स्वच्छपणे चालते परंतु वास्तविक क्लायंटसाठी प्रतिसाद अजूनही मंद आहेत.
तुम्ही कदाचित क्लायंटच्या विनंतीपेक्षा वेगळा कॅशे प्रकार भरत आहात — सामान्यतः Authorization हेडर, कुकी किंवा हेडरमुळे तुमचे CDN बदलते. वास्तविक क्लायंट पाठवलेल्या अचूक विनंतीची वॉर्मरने पाठवलेल्या विनंतीशी तुलना करा.
मी एक अंत्यबिंदू उबदार करू शकतो ज्यासाठी स्वाक्षरी केलेले, अल्पकालीन टोकन आवश्यक आहे?
विश्वासार्ह नाही, कारण वॉर्मर प्रति धाव नवीन स्वाक्षरी तयार करू शकत नाही. एकतर कॅशे करण्यायोग्य अनधिकृत प्रकार उघड करा किंवा ते सुरक्षित असेल तेथे दीर्घकालीन सेवा टोकन वापरा.