होस्टिंग REST API का इस्तेमाल करके अपनी साइट पर डिप्लॉय करें

Firebase Hosting REST API की मदद से, Firebase की होस्ट की गई साइटों पर प्रोग्राम के हिसाब से और अपनी पसंद के मुताबिक डिप्लॉयमेंट किए जा सकते हैं. नए या अपडेट किए गए Hosting कॉन्टेंट और कॉन्फ़िगरेशन को डिप्लॉय करने के लिए, इस REST API का इस्तेमाल करें.

डिप्लॉयमेंट के लिए Firebase सीएलआई का इस्तेमाल करने के बजाय, Firebase Hosting REST API का इस्तेमाल किया जा सकता है. इससे, प्रोग्राम के हिसाब से अपनी साइट के लिए एसेट का नया version बनाया जा सकता है. साथ ही, उस वर्शन में फ़ाइलें अपलोड की जा सकती हैं और फिर उस वर्शन को अपनी साइट पर डिप्लॉय किया जा सकता है.

उदाहरण के लिए, Firebase Hosting REST API की मदद से ये काम किए जा सकते हैं:

  • डिप्लॉयमेंट शेड्यूल करना. क्रॉन जॉब के साथ REST API का इस्तेमाल करके, Firebase पर होस्ट किए गए कॉन्टेंट को नियमित शेड्यूल के हिसाब से बदला जा सकता है. उदाहरण के लिए, अपने कॉन्टेंट का कोई खास छुट्टी या इवेंट से जुड़ा वर्शन डिप्लॉय करने के लिए.

  • डेवलपर टूल के साथ इंटिग्रेट करें. अपने टूल में एक विकल्प बनाया जा सकता है, ताकि एक ही क्लिक में Firebase Hosting पर वेब ऐप्लिकेशन प्रोजेक्ट डिप्लॉय किए जा सकें. उदाहरण के लिए, IDE में मौजूद डिप्लॉय बटन पर क्लिक करना.

  • स्टैटिक कॉन्टेंट जनरेट होने पर, डिप्लॉयमेंट को ऑटोमेट करें. जब कोई प्रोसेस, प्रोग्राम के हिसाब से स्टैटिक कॉन्टेंट जनरेट करती है, तो जनरेट किए गए कॉन्टेंट को डाइनैमिक तौर पर दिखाने के बजाय, स्टैटिक फ़ाइलों के तौर पर डिप्लॉय किया जा सकता है. उदाहरण के लिए, यूज़र जनरेटेड कॉन्टेंट, जैसे कि विकी या समाचार लेख. इससे, आपको महंगी कंप्यूटिंग पावर की बचत होती है और आपकी फ़ाइलों को ज़्यादा स्केलैबल तरीके से दिखाया जा सकता है.

इस गाइड में सबसे पहले, एपीआई को चालू करने, उसकी पुष्टि करने, और उसे अनुमति देने का तरीका बताया गया है. इसके बाद, इस गाइड में एक उदाहरण के ज़रिए Firebase Hostingवर्शन बनाने, उसमें ज़रूरी फ़ाइलें अपलोड करने, और आखिर में वर्शन को डिप्लॉय करने का तरीका बताया गया है.

इस REST API के बारे में ज़्यादा जानने के लिए, Hosting REST API के रेफ़रंस दस्तावेज़ देखें.

शुरू करने से पहले: REST API चालू करना

आपको Google API कंसोल में Firebase Hosting REST API को चालू करना होगा:

  1. Google API कंसोल में, Firebase Hosting एपीआई पेज खोलें.

  2. जब कहा जाए, तब अपना Firebase प्रोजेक्ट चुनें.

  3. Firebase Hosting एपीआई पेज पर, चालू करें पर क्लिक करें.

पहला चरण: एपीआई अनुरोधों की पुष्टि करने और उन्हें अनुमति देने के लिए ऐक्सेस टोकन पाना

Firebase प्रोजेक्ट में Google के सेवा खाते काम करते हैं. इनका इस्तेमाल, अपने ऐप्लिकेशन सर्वर या भरोसेमंद एनवायरमेंट से Firebase सर्वर एपीआई को कॉल करने के लिए किया जा सकता है. अगर स्थानीय तौर पर कोड डेवलप किया जा रहा है या ऐप्लिकेशन को ऑन-प्राइमिस डिप्लॉय किया जा रहा है, तो सर्वर के अनुरोधों को अनुमति देने के लिए, इस सेवा खाते से मिले क्रेडेंशियल का इस्तेमाल किया जा सकता है.

किसी सेवा खाते की पुष्टि करने और उसे Firebase की सेवाओं को ऐक्सेस करने की अनुमति देने के लिए, आपको JSON फ़ॉर्मैट में निजी कुंजी फ़ाइल जनरेट करनी होगी.

अपने सेवा खाते के लिए निजी पासकोड फ़ाइल जनरेट करने के लिए:

  1. Firebase कंसोल में, सेटिंग > सेवा खाते खोलें.

  2. नई निजी कुंजी जनरेट करें पर क्लिक करें. इसके बाद, कुंजी जनरेट करें पर क्लिक करके पुष्टि करें.

  3. कुंजी वाली JSON फ़ाइल को सुरक्षित तरीके से सेव करें.

अपनी पसंदीदा भाषा के लिए, Google Auth Library के साथ अपने Firebase क्रेडेंशियल का इस्तेमाल करके, कुछ समय के लिए मान्य OAuth 2.0 ऐक्सेस टोकन पाएं:

node.js

const {google} = require('googleapis');
function getAccessToken() {
  return new Promise(function(resolve, reject) {
    var key = require('./service-account.json');
    var jwtClient = new google.auth.JWT(
      key.client_email,
      null,
      key.private_key,
      SCOPES,
      null
    );
    jwtClient.authorize(function(err, tokens) {
      if (err) {
        reject(err);
        return;
      }
      resolve(tokens.access_token);
    });
  });
}

इस उदाहरण में, Google API क्लाइंट लाइब्रेरी, अनुरोध की पुष्टि JSON वेब टोकन या JWT की मदद से करती है. ज़्यादा जानकारी के लिए, JSON वेब टोकन देखें.

Python

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token

Java

private static String getAccessToken() throws IOException {
  GoogleCredential googleCredential = GoogleCredential
      .fromStream(new FileInputStream("service-account.json"))
      .createScoped(Arrays.asList(SCOPES));
  googleCredential.refreshToken();
  return googleCredential.getAccessToken();
}

ऐक्सेस टोकन की समयसीमा खत्म होने के बाद, अपडेट किया गया ऐक्सेस टोकन पाने के लिए, टोकन रीफ़्रेश करने का तरीका अपने-आप लागू हो जाता है.

का इस्तेमाल करने की अनुमति मिल पाएगी.

दूसरा चरण: पक्का करना कि आपके प्रोजेक्ट में डिफ़ॉल्ट Hosting साइट हो

Firebase Hosting पर पहली बार डिप्लॉय करने से पहले, आपके Firebase प्रोजेक्ट में डिफ़ॉल्ट Hosting SITE होना चाहिए.

  1. sites.list एंडपॉइंट को कॉल करके देखें कि आपके प्रोजेक्ट में पहले से ही कोई डिफ़ॉल्ट Hosting साइट है या नहीं.

    उदाहरण के लिए:

    cURL कमांड

    curl -H "Content-Type: application/json" \
       -H "Authorization: Bearer ACCESS_TOKEN" \

https://firebasehosting.googleapis.com/v1beta1/projects/PROJECT_ID/sites

    रॉ एचटीटीपीएस अनुरोध

    Host: firebasehosting.googleapis.com

POST /v1beta1/projects/PROJECT_ID/sites HTTP/1.1
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

    • अगर किसी साइट में "type": "DEFAULT_SITE" है, तो आपके प्रोजेक्ट में पहले से ही एक डिफ़ॉल्ट Hosting साइट मौजूद है. इस चरण के बाकी हिस्से को छोड़ें और अगले चरण पर जाएं: अपनी साइट के लिए नया वर्शन बनाएं.

    • अगर आपको खाली कलेक्शन मिलता है, तो इसका मतलब है कि आपके पास डिफ़ॉल्ट Hosting साइट नहीं है. इस चरण के बाकी हिस्से को पूरा करें.

  2. अपनी डिफ़ॉल्ट Hosting साइट के लिए SITE_ID तय करें. SITE_ID तय करते समय, इन बातों का ध्यान रखें:

    • इस SITE_ID का इस्तेमाल, डिफ़ॉल्ट Firebase सबडोमेन बनाने के लिए किया जाता है:
      SITE_ID.web.app और SITE_ID.firebaseapp.com.

    • SITE_ID के लिए ये ज़रूरी शर्तें हैं:

      • यह एक मान्य होस्टनेम लेबल होना चाहिए. इसका मतलब है कि इसमें ., _ वगैरह नहीं हो सकते.
      • इसमें 30 या उससे कम वर्ण होने चाहिए
      • Firebase में यह नाम दुनिया भर में यूनीक होना चाहिए

    ध्यान दें कि हम अक्सर अपनी डिफ़ॉल्ट Hosting साइट के लिए, SITE_ID के तौर पर अपने प्रोजेक्ट आईडी का इस्तेमाल करने का सुझाव देते हैं. Firebase प्रोजेक्ट के बारे में जानकारी में जाकर, यह आईडी ढूंढने का तरीका जानें.

  3. अपनी डिफ़ॉल्ट Hosting साइट बनाने के लिए, sites.create एंडपॉइंट को कॉल करें. इसके लिए, siteId पैरामीटर के तौर पर अपनी पसंद का SITE_ID इस्तेमाल करें.

    उदाहरण के लिए:

    cURL कमांड

    curl -H "Content-Type: application/json" \
       -H "Authorization: Bearer ACCESS_TOKEN" \

https://firebasehosting.googleapis.com/v1beta1/projects/PROJECT_ID/sites?siteId=SITE_ID

    रॉ एचटीटीपीएस अनुरोध

    Host: firebasehosting.googleapis.com

POST /v1beta1/projects/PROJECT_ID/sites?siteId=SITE_ID
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

    sites.create को किया गया यह एपीआई कॉल, यह JSON दिखाता है:

    {
  "name": "projects/PROJECT_ID/sites/SITE_ID",
  "defaultUrl": "https://SITE_ID.web.app",
  "type": "DEFAULT_SITE"
}

तीसरा चरण: अपनी साइट का नया वर्शन बनाना

आपका पहला एपीआई कॉल, अपनी साइट के लिए नया Version बनाना है. इस गाइड में आगे, आपको इस वर्शन में फ़ाइलें अपलोड करनी होंगी. इसके बाद, इसे अपनी साइट पर डिप्लॉय करना होगा.

  1. आपको जिस साइट पर डिप्लॉय करना है उसके लिए SITE_ID तय करें.

  2. कॉल में अपने SITE_ID का इस्तेमाल करके, versions.create एंडपॉइंट को कॉल करें.

    (ज़रूरी नहीं) कॉल में Firebase Hosting कॉन्फ़िगरेशन ऑब्जेक्ट भी पास किया जा सकता है. इसमें, एक हेडर सेट करना भी शामिल है, जो तय समय के लिए सभी फ़ाइलों को कैश मेमोरी में सेव करता है.

    उदाहरण के लिए:

    cURL कमांड

    curl -H "Content-Type: application/json" \
       -H "Authorization: Bearer ACCESS_TOKEN" \
       -d '{
             "config": {
               "headers": [{
                 "glob": "**",
                 "headers": {
                   "Cache-Control": "max-age=1800"
                 }
               }]
             }
           }' \
https://firebasehosting.googleapis.com/v1beta1/sites/SITE_ID/versions

    रॉ एचटीटीपीएस अनुरोध

    Host: firebasehosting.googleapis.com

POST /v1beta1/sites/SITE_ID/versions HTTP/1.1
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
Content-Length: 134

{
  "config": {
    "headers": [{
      "glob": "**",
      "headers": {
        "Cache-Control": "max-age=1800"
      }
    }]
  }
}

versions.create को किया गया यह एपीआई कॉल, यह JSON दिखाता है:

{
  "name": "sites/SITE_ID/versions/VERSION_ID",
  "status": "CREATED",
  "config": {
    "headers": [{
      "glob": "**",
      "headers": {
        "Cache-Control": "max-age=1800"
      }
    }]
  }
}

इस रिस्पॉन्स में, नए वर्शन के लिए यूनीक आइडेंटिफ़ायर होता है. यह आइडेंटिफ़ायर इस फ़ॉर्मैट में होता है: sites/SITE_ID/versions/VERSION_ID. इस वर्शन का रेफ़रंस देने के लिए, आपको इस गाइड में इस यूनीक आइडेंटिफ़ायर की ज़रूरत पड़ेगी.

चौथा चरण: उन फ़ाइलों की सूची दें जिन्हें आपको डिप्लॉय करना है

अब आपके पास नए वर्शन का आइडेंटिफ़ायर है. आपको Firebase Hosting को यह बताना होगा कि आपको इस नए वर्शन में कौनसी फ़ाइलें डिप्लॉय करनी हैं.

ध्यान दें कि Hosting में, हर फ़ाइल का साइज़ ज़्यादा से ज़्यादा 2 जीबी होना चाहिए.

इस एपीआई के लिए, आपको SHA256 हैश की मदद से फ़ाइलों की पहचान करनी होगी. इसलिए, एपीआई कॉल करने से पहले, आपको हर स्टैटिक फ़ाइल के लिए हैश का हिसाब लगाना होगा. इसके लिए, आपको फ़ाइलों को Gzipping करके, हर नई कंप्रेस की गई फ़ाइल का SHA256 हैश लेना होगा.

अपने उदाहरण को जारी रखते हुए, मान लें कि आपको नए वर्शन में तीन फ़ाइलें डिप्लॉय करनी हैं: file1, file2, और file3.

  1. फ़ाइलों को gzip फ़ॉर्मैट में बदलें:

    gzip file1 && gzip file2 && gzip file3

    अब आपके पास तीन संपीड़ित फ़ाइलें file1.gz, file2.gz, और file3.gz हैं.

  2. हर कंप्रेस की गई फ़ाइल का SHA256 हैश पाएं:

    cat file1.gz | openssl dgst -sha256

66d61f86bb684d0e35f94461c1f9cf4f07a4bb3407bfbd80e518bd44368ff8f4

    cat file2.gz | openssl dgst -sha256

490423ebae5dcd6c2df695aea79f1f80555c62e535a2808c8115a6714863d083

    cat file3.gz | openssl dgst -sha256

59cae17473d7dd339fe714f4c6c514ab4470757a4fe616dfdb4d81400addf315

    अब आपके पास तीन कंप्रेस की गई फ़ाइलों के तीन SHA256 हैश हैं.

  3. इन तीन हैश को एपीआई अनुरोध में, versions.populateFiles एंडपॉइंट पर भेजें. अपलोड की गई फ़ाइल के लिए, हर हैश को पसंदीदा पाथ के हिसाब से सूची में शामिल करें. उदाहरण के लिए, /file1, /file2, और /file3.

    उदाहरण के लिए:

    cURL कमांड

    $ curl -H "Content-Type: application/json" \
         -H "Authorization: Bearer ACCESS_TOKEN" \
         -d '{
               "files": {
                 "/file1": "66d61f86bb684d0e35f94461c1f9cf4f07a4bb3407bfbd80e518bd44368ff8f4",
                 "/file2": "490423ebae5dcd6c2df695aea79f1f80555c62e535a2808c8115a6714863d083",
                 "/file3": "59cae17473d7dd339fe714f4c6c514ab4470757a4fe616dfdb4d81400addf315"
               }
             }' \
https://firebasehosting.googleapis.com/v1beta1/sites/SITE_ID/versions/VERSION_ID:populateFiles

    रॉ एचटीटीपीएस अनुरोध

    Host: firebasehosting.googleapis.com

POST /v1beta1/sites/SITE_ID/versions/VERSION_ID:populateFiles HTTP/1.1
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
Content-Length: 181

{
  "files": {
    "/file1": "66d61f86bb684d0e35f94461c1f9cf4f07a4bb3407bfbd80e518bd44368ff8f4",
    "/file2": "490423ebae5dcd6c2df695aea79f1f80555c62e535a2808c8115a6714863d083",
    "/file3": "59cae17473d7dd339fe714f4c6c514ab4470757a4fe616dfdb4d81400addf315"
  }
}

versions.populateFiles को किया गया यह एपीआई कॉल, यह JSON दिखाता है:

{
  "uploadRequiredHashes": [
    "490423ebae5dcd6c2df695aea79f1f80555c62e535a2808c8115a6714863d083",
    "59cae17473d7dd339fe714f4c6c514ab4470757a4fe616dfdb4d81400addf315"
  ],
  "uploadUrl": "https://upload-firebasehosting.googleapis.com/upload/sites/SITE_ID/versions/VERSION_ID/files"
}

इस जवाब में ये चीज़ें शामिल हैं:

  • अपलोड की जाने वाली हर फ़ाइल का हैश. उदाहरण के लिए, इस उदाहरण में file1 को पहले से ही किसी पिछले वर्शन में अपलोड किया जा चुका था. इसलिए, इसका हैश uploadRequiredHashes की सूची में शामिल नहीं है.

  • uploadUrl, जो नए वर्शन के लिए खास तौर पर है.

दो नई फ़ाइलें अपलोड करने के अगले चरण में, आपको versions.populateFiles जवाब से हैश और uploadURL की ज़रूरत होगी.

पांचवां चरण: ज़रूरी फ़ाइलें अपलोड करना

आपको हर ज़रूरी फ़ाइल को अलग से अपलोड करना होगा. ये वे फ़ाइलें हैं जो पिछले चरण में मिले versions.populateFiles रिस्पॉन्स में uploadRequiredHashes में दी गई हैं. इन फ़ाइलों को अपलोड करने के लिए, आपको पिछले चरण में मिली फ़ाइल हैश और uploadUrl की ज़रूरत होगी.

  1. uploadUrl में फ़ॉरवर्ड स्लैश और फ़ाइल का हैश जोड़कर, फ़ाइल के हिसाब से यूआरएल बनाएं. यह यूआरएल इस फ़ॉर्मैट में होना चाहिए: https://upload-firebasehosting.googleapis.com/upload/sites/SITE_ID/versions/VERSION_ID/files/FILE_HASH.

  2. अनुरोधों की सीरीज़ का इस्तेमाल करके, फ़ाइल के यूआरएल पर सभी ज़रूरी फ़ाइलों को एक-एक करके अपलोड करें. इस उदाहरण में, सिर्फ़ file2.gz और file3.gz को अपलोड किया गया है.

    उदाहरण के लिए, कंप्रेस किए गए file2.gz को अपलोड करने के लिए:

    cURL कमांड

    curl -H "Authorization: Bearer ACCESS_TOKEN" \
       -H "Content-Type: application/octet-stream" \
       --data-binary @./file2.gz \
https://upload-firebasehosting.googleapis.com/upload/sites/SITE_ID/versions/VERSION_ID/files/FILE_HASH

    रॉ एचटीटीपीएस अनुरोध

    Host: upload-firebasehosting.googleapis.com

POST /upload/sites/SITE_ID/versions/VERSION_ID/files/FILE_HASH HTTP/1.1
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/octet-stream
Content-Length: 500

content-of-file2.gz

अपलोड हो जाने पर, 200 OK एचटीटीपीएस रिस्पॉन्स मिलता है.

छठा चरण: वर्शन का स्टेटस 'पूरा हो गया' पर अपडेट करना

versions.populateFiles रिस्पॉन्स में दी गई सभी फ़ाइलें अपलोड करने के बाद, अपने वर्शन का स्टेटस FINALIZED पर अपडेट किया जा सकता है.

अपने एपीआई अनुरोध में status फ़ील्ड को FINALIZED पर सेट करके, versions.patch एंडपॉइंट को कॉल करें.

उदाहरण के लिए:

cURL कमांड

curl -H "Content-Type: application/json" \
       -H "Authorization: Bearer ACCESS_TOKEN" \
       -X PATCH \
       -d '{"status": "FINALIZED"}' \
https://firebasehosting.googleapis.com/v1beta1/sites/SITE_ID/versions/VERSION_ID?update_mask=status

रॉ एचटीटीपीएस अनुरोध

Host: firebasehosting.googleapis.com

PATCH /v1beta1/sites/SITE_ID/versions/VERSION_ID?update_mask=status HTTP/1.1
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
Content-Length: 23

{"status": "FINALIZED"}

versions.patch को किया गया यह एपीआई कॉल, नीचे दिया गया JSON दिखाता है. देखें कि status को FINALIZED पर अपडेट किया गया है या नहीं.

{
  "name": "sites/SITE_ID/versions/VERSION_ID",
  "status": "FINALIZED",
  "config": {
    "headers": [{
      "glob": "**",
      "headers": {"Cache-Control": "max-age=1800"}
    }]
  },
  "createTime": "2018-12-02T13:41:56.905743Z",
  "createUser": {
    "email": "SERVICE_ACCOUNT_EMAIL@SITE_ID.iam.gserviceaccount.com"
  },
  "finalizeTime": "2018-12-02T14:56:13.047423Z",
  "finalizeUser": {
    "email": "USER_EMAIL@DOMAIN.tld"
  },
  "fileCount": "5",
  "versionBytes": "114951"
}

सातवां चरण: डिप्लॉयमेंट के लिए वर्शन रिलीज़ करना

अब आपके पास आखिरी वर्शन है, इसलिए उसे डिप्लॉयमेंट के लिए रिलीज़ करें. इस चरण के लिए, आपको अपने वर्शन का एक Release बनाना होगा. इसमें होस्टिंग कॉन्फ़िगरेशन और नए वर्शन की सभी कॉन्टेंट फ़ाइलें होनी चाहिए.

अपनी रिलीज़ बनाने के लिए, releases.create एंडपॉइंट को कॉल करें.

उदाहरण के लिए:

cURL कमांड

curl -H "Authorization: Bearer ACCESS_TOKEN" \
       -X POST
https://firebasehosting.googleapis.com/v1beta1/sites/SITE_ID/releases?versionName=sites/SITE_ID/versions/VERSION_ID

रॉ एचटीटीपीएस अनुरोध

Host: firebasehosting.googleapis.com

POST /v1beta1/sites/SITE_ID/releases?versionName=sites/SITE_ID/versions/VERSION_ID HTTP/1.1
Authorization: Bearer ACCESS_TOKEN

releases.create को किया गया यह एपीआई कॉल, यह JSON दिखाता है:

{
  "name": "sites/SITE_ID/releases/RELEASE_ID",
  "version": {
    "name": "sites/SITE_ID/versions/VERSION_ID",
    "status": "FINALIZED",
    "config": {
    "headers": [{
      "glob": "**",
      "headers": {"Cache-Control": "max-age=1800"}
    }]
  }
  },
  "type": "DEPLOY",
  "releaseTime": "2018-12-02T15:14:37Z"
}

होस्टिंग कॉन्फ़िगरेशन और नए वर्शन की सभी फ़ाइलें अब आपकी साइट पर डिप्लॉय हो गई होंगी. साथ ही, इन यूआरएल का इस्तेमाल करके अपनी फ़ाइलों को ऐक्सेस किया जा सकता है:

  • https://SITE_ID.web.app/file1
  • https://SITE_ID.web.app/file2
  • https://SITE_ID.web.app/file3

इन फ़ाइलों को आपके SITE_ID.firebaseapp.com डोमेन से जुड़े यूआरएल पर भी ऐक्सेस किया जा सकता है.

Firebase कंसोल के Hosting डैशबोर्ड में भी, अपनी नई रिलीज़ की सूची देखी जा सकती है.