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

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

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

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

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

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

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

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

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

Дополнительную информацию об этом REST API можно найти в полной справочной документации по Hosting REST API .

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

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

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 Library для предпочитаемого вами языка, чтобы получить кратковременный токен доступа OAuth 2.0:

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);
    });
  });
}

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 должен иметь Hosting SITE по умолчанию.

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

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

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. Вызовите конечную точку version.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"
      }
    }]
  }
}

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

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

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

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

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