Развертывание на своем сайте с помощью API REST хостинга.

API REST Firebase Hosting обеспечивает программное и настраиваемое развертывание на ваших сайтах, размещенных на Firebase. Используйте этот REST API для развертывания нового или обновленного содержимого и конфигурации Hosting .

В качестве альтернативы использованию Firebase CLI для развертываний вы можете использовать REST API Firebase Hosting , чтобы программно создать новую version ресурсов для вашего сайта, загрузить файлы в эту версию, а затем развернуть ее на своем сайте.

Например, с помощью REST API Firebase Hosting вы можете:

  • Расписание развертываний. Используя REST API в сочетании с заданием cron, вы можете регулярно изменять контент, размещенный в Firebase (например, для развертывания специальной версии вашего контента, связанной с праздниками или событиями).

  • Интеграция с инструментами разработчика. Вы можете создать в своем инструменте опцию для развертывания проектов веб-приложений на Firebase Hosting одним щелчком мыши (например, нажатием кнопки развертывания в IDE).

  • Автоматизируйте развертывание при создании статического контента. Когда процесс программно генерирует статический контент (например, пользовательский контент, такой как вики или новостная статья), вы можете развернуть сгенерированный контент в виде статических файлов, а не обслуживать его динамически. Это экономит дорогостоящие вычислительные мощности и обеспечивает более масштабируемое обслуживание ваших файлов.

В этом руководстве сначала описывается, как включить, аутентифицировать и авторизовать API. Затем в этом руководстве рассматривается пример создания версии Firebase Hosting , загрузки необходимых файлов в версию и, наконец, развертывания версии.

Вы также можете узнать больше об этом REST API в полной справочной документации Hosting REST API .

Прежде чем начать: включите REST API.

Вам необходимо включить REST API Firebase Hosting в консоли Google API:

  1. Откройте страницу Firebase Hosting API в консоли Google API.

  2. При появлении запроса выберите свой проект Firebase.

  3. Нажмите «Включить» на странице Firebase Hosting API.

Шаг 1. Получите токен доступа для аутентификации и авторизации запросов API.

Проекты Firebase поддерживают учетные записи служб Google, которые вы можете использовать для вызова API-интерфейсов сервера Firebase с вашего сервера приложений или доверенной среды. Если вы разрабатываете код локально или развертываете приложение локально, вы можете использовать учетные данные, полученные через эту учетную запись службы, для авторизации запросов к серверу.

Чтобы аутентифицировать учетную запись службы и разрешить ей доступ к службам Firebase, вам необходимо создать файл закрытого ключа в формате JSON.

Чтобы создать файл закрытого ключа для вашей учетной записи службы:

  1. В консоли Firebase откройте «Настройки» > «Учетные записи служб» .

  2. Нажмите «Создать новый закрытый ключ» , затем подтвердите действие, нажав «Создать ключ» .

  3. Надежно сохраните файл JSON, содержащий ключ.

Используйте свои учетные данные Firebase вместе с библиотекой Google Auth для предпочитаемого вами языка, чтобы получить недолговечный токен доступа OAuth 2.0:

узел.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 .

Питон 

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

Ява

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

По истечении срока действия токена доступа метод обновления токена вызывается автоматически для получения обновленного токена доступа.

Шаг 2. Убедитесь, что в вашем проекте есть Hosting по умолчанию.

Перед первым развертыванием на Firebase Hosting ваш проект Firebase должен иметь SITE Hosting по умолчанию.

  1. Проверьте, есть ли у вашего проекта Hosting сайт по умолчанию, вызвав конечную точку sites.list .

    Например:

    команда cURL 

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

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

    Необработанный HTTPS-запрос

    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. Определите SITE_ID для вашего сайта Hosting по умолчанию. При выборе SITE_ID помните следующее:

    • Этот SITE_ID используется для создания поддоменов Firebase по умолчанию:
      SITE_ID .web.app и SITE_ID .firebaseapp.com .

    • К SITE_ID предъявляются следующие требования:

      • Должна быть допустимой меткой имени хоста, то есть она не может содержать . , _ , и т. д.
      • Должно быть 30 символов или меньше.
      • Должно быть глобально уникальным в Firebase.

    Обратите внимание, что мы часто рекомендуем использовать идентификатор вашего проекта в качестве SITE_ID для вашего Hosting сайта по умолчанию. Узнайте, как найти этот идентификатор, в разделе «Понимание проектов Firebase» .

  3. Создайте сайт Hosting по умолчанию, вызвав конечную точку sites.create , используя желаемый SITE_ID в качестве параметра siteId .

    Например:

    команда cURL 

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

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

    Необработанный HTTPS-запрос

    Host: firebasehosting.googleapis.com

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

    Этот вызов API sites.create возвращает следующий JSON:

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

Шаг 3. Создайте новую версию своего сайта.

Ваш первый вызов API — создать новую Version для вашего сайта. Далее в этом руководстве вы загрузите файлы в эту версию, а затем развернете ее на своем сайте.

  1. Определите SITE_ID сайта, на котором вы хотите выполнить развертывание.

  2. Вызовите конечную точкуversions.create , используя в вызове свой SITE_ID .

    (Необязательно) Вы также можете передать в вызове объект конфигурации 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

    Необработанный HTTPS-запрос

    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"
      }
    }]
  }
}

Этот вызов API 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 . Этот уникальный идентификатор понадобится вам в этом руководстве для ссылки на эту конкретную версию.

Шаг 4. Укажите список файлов, которые вы хотите развернуть.

Теперь, когда у вас есть идентификатор новой версии, вам нужно сообщить Firebase Hosting какие файлы вы хотите в конечном итоге развернуть в этой новой версии.

Обратите внимание, что Hosting максимальный размер отдельных файлов составляет 2 ГБ.

Этот API требует, чтобы вы идентифицировали файлы по хешу SHA256. Итак, прежде чем вы сможете выполнить вызов API, вам сначала нужно вычислить хэш для каждого статического файла, сжимая файлы, а затем взяв хэш SHA256 каждого вновь сжатого файла.

Продолжая наш пример, предположим, что вы хотите развернуть в новой версии три файла: file1 , file2 и file3 .

  1. Заархивируйте файлы:

    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. Отправьте эти три хеша в запросе API в конечную 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

    Необработанный HTTPS-запрос

    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"
  }
}

Этот вызов API versions.populateFiles возвращает следующий JSON:

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

Этот ответ включает в себя:

  • Хэш каждого файла , который необходимо загрузить. Например, в этом примере file1 уже был загружен в предыдущей версии, поэтому его хэш не включен в список uploadRequiredHashes .

  • uploadUrl , специфичный для новой версии.

На следующем этапе загрузки двух новых файлов вам понадобятся хэши и uploadURL из versions.populateFiles .

Шаг 5. Загрузите необходимые файлы.

Вам необходимо индивидуально загрузить каждый необходимый файл (те файлы, которые указаны в uploadRequiredHashes из versions.populateFiles на предыдущем шаге). Для загрузки этих файлов вам понадобятся хэши файлов и uploadUrl из предыдущего шага.

  1. Добавьте косую черту и хэш файла к URL- uploadUrl , чтобы создать URL-адрес для конкретного файла в формате: https://upload-firebasehosting.googleapis.com/upload/sites/ SITE_ID /versions/ VERSION_ID /files/ FILE_HASH .

  2. Загрузите все необходимые файлы один за другим (в этом примере только file2.gz и file3.gz ) по URL-адресу конкретного файла, используя серию запросов.

    Например, чтобы загрузить сжатый 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

    Необработанный HTTPS-запрос

    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

Успешные загрузки возвращают HTTPS-ответ 200 OK .

Шаг 6. Обновите статус версии на ЗАВЕРШЕНО.

После того как вы загрузили все файлы, перечисленные в versions.populateFiles , вы можете обновить статус вашей версии на FINALIZED .

Вызовите конечную versions.patch с полем status в вашем запросе API, установленным в FINALIZED .

Например:

команда 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

Необработанный HTTPS-запрос

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"}

Этот вызов API 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"
}

Шаг 7. Выпустите версию для развертывания.

Теперь, когда у вас есть окончательная версия, выпустите ее для развертывания. Для этого шага вам необходимо создать 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

Необработанный HTTPS-запрос

Host: firebasehosting.googleapis.com

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

Этот вызов API 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"
}

Конфигурация хостинга и все файлы новой версии теперь должны быть развернуты на вашем сайте, и вы можете получить доступ к своим файлам, используя URL-адреса:

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

Эти файлы также доступны по URL-адресам, связанным с вашим доменом SITE_ID .firebaseapp.com .

Вы также можете увидеть свой новый выпуск в списке на панели Hosting консоли Firebase .