HTTP istekleriyle işlevleri çağırma (1. nesil)

functions.https kullanarak bir HTTP isteği aracılığıyla işlev tetikleyebilirsiniz. Bu sayede, aşağıdaki desteklenen HTTP yöntemleri aracılığıyla senkron bir işlevi çağırabilirsiniz: GET, POST, PUT, DELETE ve OPTIONS.

Bu sayfadaki örnekler, işlevler uç noktasına bir HTTP GET isteği gönderdiğinizde tetiklenen bir örnek işleme dayanmaktadır. Örnek işlev, mevcut sunucu saatini alır, saati bir URL sorgu parametresinde belirtildiği şekilde biçimlendirir ve sonucu HTTP yanıtında gönderir.

HTTP isteğiyle işlev tetikleme

HTTP etkinliklerini işleyen bir işlev oluşturmak için functions.https öğesini kullanın. Bir HTTP işlevinin etkinlik işleyicisi, onRequest() etkinliğini dinler. Bu etkinlik, Express web çerçevesi tarafından yönetilen yönlendiricileri ve uygulamaları destekler.

Express istek ve yanıt nesnelerini kullanma

onRequest() için bağımsız değişken olarak kullanılan Request nesnesi, istemci tarafından gönderilen HTTP isteğinin özelliklerine erişmenizi sağlar. Response nesnesi ise istemciye yanıt göndermenizi sağlar.

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

Mevcut Express uygulamalarını kullanma

onRequest() için bağımsız değişken olarak App'i kullanarak bir HTTP işlevine tam bir Express uygulaması iletebilirsiniz. Ortak metin kodu, gösterildiği gibi ara katman yazılımına taşınabilir:

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 işlevi çağırma

Bir HTTP işlevini dağıttıktan sonra, kendi benzersiz URL'si üzerinden çağırabilirsiniz. URL sırasıyla şunları içerir:

• İşlevinizi dağıttığınız bölge (veya bölgeler). Bazı üretim işlevlerinin, ağ gecikmesini en aza indirmek için konumu açıkça ayarlaması gerekebilir.
• Firebase proje kimliğiniz
• cloudfunctions.net
• İşlevinizin adı

Örneğin, date() işlevini çağırmak için kullanılan URL aşağıdaki gibi görünür:

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

İşlevleri dağıtırken izin hatalarıyla karşılaşırsanız dağıtım komutlarını çalıştıran kullanıcıya uygun IAM rollerinin atandığından emin olun.

Express uygulama yönlendirme ile işlev adı, tanımladığınız uygulamadaki URL yollarına önek olarak eklenir. Örneğin, yukarıdaki Express uygulaması örneğinde getter'ı çağıran URL şu şekilde görünür:

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

HTTP işlevlerini güvenlik duvarı veya IP filtresi arkasında çağırıyorsanız Google'ın HTTP işlevlerini sunmak için kullandığı IP adreslerini arayabilirsiniz.

Cloud Functions ile ara katman yazılımı modüllerini kullanma

Çerez desteği veya CORS gibi işlemler için ara yazılım bağımlılıklarını yerleştirmeniz gerekiyorsa bunları işlev içinde çağırın. Örneğin, CORS desteğini etkinleştirmek için aşağıdaki bloğu ekleyin:

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

İstekten değerleri okuma

Bu ayrıştırma işlemi aşağıdaki gövde ayrıştırıcılar tarafından yapılır:

• JSON gövde ayrıştırıcısı
• Ham gövde ayrıştırıcı
• Metin gövdesi ayrıştırıcısı
• URL biçiminde kodlanmış form gövdesi ayrıştırıcısı

İşlevinizin aşağıdaki istekle çağrıldığını varsayalım:

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

Bu durumda gönderilen veriler şu konumda somutlaştırılır:

date() işlevi örneğinde, işlev hem URL parametresini hem de gövdeyi kullanılacak tarih/saat biçimini ayarlamak için format değeri açısından test eder:

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

HTTP işlevlerini sonlandırma

HTTP işlevlerini her zaman send(), redirect() veya end() ile sonlandırın. Aksi takdirde işleviniz çalışmaya devam edebilir ve sistem tarafından zorla sonlandırılabilir. Ayrıca Sync, Async and Promises (Senkronize, Eşzamansız ve Sözler) başlıklı makaleyi de inceleyin.

Node.js moment modülünü kullanarak sunucu saatini alıp biçimlendirdikten sonra date() işlevi, sonucu HTTP yanıtında göndererek tamamlanır:

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

HTTP işlevlerini Firebase Hosting'ya bağlama

Bir HTTP işlevini Firebase Hosting'ya bağlayabilirsiniz. Firebase Hosting sitenizdeki istekler belirli HTTP işlevlerine yönlendirilebilir. Bu sayede, HTTP işleviyle kendi özel alanınızı da kullanabilirsiniz. Cloud Functions ile Firebase Hosting arasındaki bağlantı hakkında daha fazla bilgi edinin.