透過 HTTP 要求呼叫函式

您可以使用 functions.https 透過 HTTP 要求觸發函式。這可讓您透過下列支援的 HTTP 方法叫用同步函式：GET、POST、PUT、DELETE 和 OPTIONS。

本頁的範例是以範例函式為基礎，當您將 HTTP GET 要求傳送至函式端點時，就會觸發這類函式。範例函式會擷取目前的伺服器時間，並按照網址查詢參數中指定的格式設定時間，然後在 HTTP 回應中傳送結果。

透過 HTTP 要求觸發函式

使用 functions.https 建立可處理 HTTP 事件的函式。HTTP 函式事件處理常式會監聽 onRequest() 事件，這項事件支援由 Express 網路架構管理的路由器和應用程式。

使用 Express 要求和回應物件

Request 物件可做為 onRequest() 的引數，讓您存取用戶端傳送的 HTTP 要求屬性，而 Response 物件則可讓您將回應傳回給用戶端。

exports.date = functions.https.onRequest((req, res) => {
  // ...
});

使用現有的 Express 應用程式

您可以使用 App 做為 onRequest() 的引數，將完整的 Express 應用程式傳遞至 HTTP 函式。程式碼格式可移至中介軟體，如下所示：

const express = require('express');
const cors = require('cors');

const app = express();

// Automatically allow cross-origin requests
app.use(cors({ origin: true }));

// Add middleware to authenticate requests
app.use(myMiddleware);

// build multiple CRUD interfaces:
app.get('/:id', (req, res) => res.send(Widgets.getById(req.params.id)));
app.post('/', (req, res) => res.send(Widgets.create()));
app.put('/:id', (req, res) => res.send(Widgets.update(req.params.id, req.body)));
app.delete('/:id', (req, res) => res.send(Widgets.delete(req.params.id)));
app.get('/', (req, res) => res.send(Widgets.list()));

// Expose Express API as a single Cloud Function:
exports.widgets = functions.https.onRequest(app);

叫用 HTTP 函式

部署 HTTP 函式後，您可以透過其專屬網址叫用該函式。網址依序包含下列項目：

您部署函式的區域 (或區域)。部分正式版函式可能需要明確設定位置，以盡量減少網路延遲時間。
Firebase 專案 ID
cloudfunctions.net
函式名稱

舉例來說，用於叫用 date() 的網址如下所示：

https://us-central1-<project-id>.cloudfunctions.net/date

如果在部署函式時遇到權限錯誤，請務必將適當的 IAM 角色指派給執行部署指令的使用者。

使用 Express 應用程式路由時，系統會將函式名稱新增為您定義的應用程式中網址路徑的前置字串。例如，在上述 Express 應用程式範例中，用來叫用 getter 的網址如下所示：

https://us-central1-<project-id>.cloudfunctions.net/widgets/<id>

如果您在防火牆或 IP 篩選器後方叫用 HTTP 函式，可以查詢 Google 用來提供 HTTP 函式的 IP 位址。

搭配 Cloud Functions 使用中介軟體模組

如果您需要針對 Cookie 支援或 CORS 等項目插入中介軟體依附元件，請在函式中呼叫這些項目。舉例來說，如要啟用 CORS 支援，請新增下列區塊：

// Enable CORS using the `cors` express middleware.
cors(req, res, () => {
  // ...
});

讀取要求中的值

下表列出一些常見情境：

內容類型	要求內容	行為
`application/json`	`'{"name":"John"}'`	`request.body.name` 等於「John」
`application/octet-stream`	'my text'	`request.body` 等於「6d792074657874」(要求的原始位元組；請參閱 Node.js Buffer 說明文件)
`text/plain`	'my text'	`request.body` 等於「my text」
`application/x-www-form-urlencoded`	'name=John'	`request.body.name` 等於「John」

這項剖析作業會由下列內容剖析器完成：

假設您的函式會透過以下要求呼叫：

curl -X POST -H "Content-Type:application/json" -H "X-MyHeader: 123" YOUR_HTTP_TRIGGER_ENDPOINT?foo=baz -d '{"text":"something"}'

則傳送的資料會在下列情況下具體化：

屬性/方法	值
`req.method`	「POST」
`req.get('x-myheader')`	「123」
`req.query.foo`	「baz」
`req.body.text`	「something」
`req.rawBody`	要求的原始 (未剖析) 位元組

在 date() 函式範例中，函式會同時測試網址參數和內文的 format 值，以設定要使用的日期/時間格式：

let format = req.query.format;
format = req.body.format;index.js

終止 HTTP 函式

請務必使用 send()、redirect() 或 end() 結束 HTTP 函式。否則，函式可能會繼續執行，並遭系統強制終止。另請參閱「同步、非同步和承諾」。

使用 Node.js moment 模組擷取並設定伺服器時間後，date() 函式會透過在 HTTP 回應中傳送結果來結束：

const formattedDate = moment().format(`${format}`);
functions.logger.log('Sending Formatted date:', formattedDate);
res.status(200).send(formattedDate);index.js

將 HTTP 函式連結至 Firebase Hosting

您可以將 HTTP 函式連結至 Firebase Hosting。Firebase Hosting 網站上的要求可以轉送至特定 HTTP 函式。這也讓您可以搭配 HTTP 函式使用自訂網域。進一步瞭解如何將 Cloud Functions 連結至 Firebase Hosting。