API ગરમ

REST અને GraphQL અંતિમ બિંદુઓને વાસ્તવિક પદ્ધતિઓ, હેડર, કૂકીઝ, બોડી અને રૂપરેખા મેટ્રિસીસ સાથે ગરમ રાખો.

13 મિનિટ વાંચન

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

    વૈકલ્પિક રીતે રૂપરેખા મેટ્રિક્સ સાથે વિસ્તૃત કરો

    ડઝનેક નજીકના-સમાન વોર્મર્સ બનાવ્યા વિના - લોકેલ, ભાડૂતો, ID - ઘણા પ્રકારોને આવરી લો.

  6. 6

    દર અને અંતરાલો સેટ કરો, પછી સક્રિય કરો

    વેબસાઈટ વોર્મર્સ જેવો જ વિચાર: તમારી કેશ TTLને હરાવવા માટે ઘણી વાર પર્યાપ્ત ગરમ, ધીમે ધીમે નુકસાન ન થાય તેટલું.

અંતિમ બિંદુઓ

ગરમમાં દરેક અંતિમ બિંદુ સ્વતંત્ર રીતે ગોઠવેલ છે:

લેબલ
વૈકલ્પિક માનવ-વાંચી શકાય તેવું નામ, તેથી અંતિમ બિંદુઓની લાંબી સૂચિ વાંચવા યોગ્ય રહે છે.
WordPress
ચકાસાયેલ હોસ્ટનામ પર સંપૂર્ણ એન્ડપોઇન્ટ સરનામું. જ્યારે PATH પરિમાણ સાથે જોડી કરવામાં આવે ત્યારે તેમાં {id} અથવા :id જેવા પાથ પ્લેસહોલ્ડર્સ હોઈ શકે છે.
પદ્ધતિ
GET, POST, અને અન્ય તમારા પ્લાન પર આધાર રાખીને. યોજનાઓ સામાન્ય રીતે GET અને HEAD ને મૂળભૂત રીતે, ઉચ્ચ સ્તરો પર વધુ પદ્ધતિઓ સાથે મંજૂરી આપે છે.
પ્રોટોકોલ
REST અથવા GRAPHQL. GraphQL પસંદ કરવાથી ઑપરેશન અને ક્વેરી ફીલ્ડ દેખાય છે.
શરીર નમૂનાની વિનંતી કરો
મોકલવા માટેનું શરીર, પદ્ધતિઓ માટે કે જે એક વહન કરે છે. API વિનંતિના મુખ્ય પાત્રની જરૂર છે.
WordPress
વિનંતીના મુખ્ય ભાગનો સામગ્રી પ્રકાર, સામાન્ય રીતે application/json.
આળસવાળું
એન્ડપૉઇન્ટને બે વાર કૉલ કરવા માટે સલામત તરીકે ચિહ્નિત કરે છે, ઠંડા/ગરમ ડબલ ફેચને સક્ષમ કરીને જે સુધારણાને માપે છે. જ્યારે બે વાર સાચા અર્થમાં કૉલ કરવાથી કોઈ આડઅસર થતી નથી ત્યારે જ તેને સક્ષમ કરો.
સક્ષમ
શું આ ચોક્કસ એન્ડપોઇન્ટ રનમાં સામેલ છે. એક અંતિમ બિંદુને કાઢી નાખ્યા વિના અસ્થાયી રૂપે અક્ષમ કરવા માટે સરળ.

લખવાની કામગીરીને નિરાશાજનક ચિહ્નિત કરવામાં સાવચેત રહો

એન્ડપોઇન્ટ પર ડબલ ફેચ જે ઓર્ડર બનાવે છે, ઇમેઇલ મોકલે છે અથવા ચાર્જ કાર્ડ્સ તે બે વાર કરશે. માત્ર ત્યારે જ એન્ડપોઇન્ટને ચિહ્નિત કરો જ્યારે તેને પુનરાવર્તિત કરો તે ખરેખર હાનિકારક છે.

રૂપરેખા મેટ્રિસિસ

મોટા ભાગના API માં વેરિઅન્ટ હોય છે: પ્રતિ લોકેલ, ભાડૂત દીઠ, ચલણ દીઠ અથવા ID દીઠ સમાન અંતિમ બિંદુ કહેવાય છે. દરેક માટે વોર્મર બનાવવું અનિવાર્ય છે.

એક રૂપરેખા મેટ્રિક્સ આને ઉકેલે છે. તમે બહુવિધ મૂલ્યો સાથે પરિમાણોને વ્યાખ્યાયિત કરો છો, અને 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 બદલાય છે. વાસ્તવિક ક્લાયન્ટ જે મોકલે છે તેની સાથે વોર્મર જે મોકલે છે તેની સાથે ચોક્કસ વિનંતીની તુલના કરો.
શું હું એવા એન્ડપોઇન્ટને ગરમ કરી શકું જેને સહી કરેલ, અલ્પજીવી ટોકનની જરૂર હોય?
ભરોસાપાત્ર નથી, કારણ કે વોર્મર રન દીઠ તાજી સહી જનરેટ કરી શકતું નથી. ક્યાં તો કેશેબલ અનધિકૃત વેરિઅન્ટનો પર્દાફાશ કરો, અથવા જ્યાં તે સુરક્ષિત હોય ત્યાં લાંબા ગાળાની સેવા ટોકનનો ઉપયોગ કરો.