Funzioni di chiamata tramite richieste HTTP

È possibile attivare una funzione tramite una richiesta HTTP utilizzando functions.https . Ciò consente di richiamare una funzione sincrona tramite i seguenti metodi HTTP supportati: GET , POST , PUT , DELETE e OPTIONS .

Gli esempi in questa pagina si basano su una funzione di esempio che si attiva quando si invia una richiesta HTTP GET all'endpoint delle funzioni. La funzione di esempio recupera l'ora corrente del server, formatta l'ora come specificato in un parametro di query URL e invia il risultato nella risposta HTTP.

Attiva una funzione con una richiesta HTTP

Usa functions.https per creare una funzione che gestisca gli eventi HTTP. Il gestore di eventi per una funzione HTTP è in ascolto dell'evento onRequest() , che supporta router e app gestiti dal framework Web Express .

Utilizzo di oggetti di richiesta e risposta Express

Usato come argomenti per onRequest() , l'oggetto Request ti dà accesso alle proprietà della richiesta HTTP inviata dal client e l'oggetto Response ti dà un modo per inviare una risposta al client.

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

Utilizzo di app Express esistenti

Usando App come argomento per onRequest() , puoi passare un'app Express completa a una funzione HTTP. Il codice boilerplate può essere spostato nel middleware come mostrato:

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

Richiama una funzione HTTP

Dopo aver distribuito una funzione HTTP, puoi richiamarla tramite il suo URL univoco. L'URL include quanto segue, nell'ordine:

  • La regione (o le regioni) in cui hai distribuito la tua funzione. Alcune funzioni di produzione potrebbero dover impostare esplicitamente la posizione per ridurre al minimo la latenza di rete.
  • Il tuo ID progetto Firebase
  • cloudfunctions.net
  • Il nome della tua funzione

Ad esempio, l'URL per richiamare date() è simile al seguente:

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

Se si verificano errori di autorizzazione durante la distribuzione delle funzioni, assicurarsi che i ruoli IAM appropriati siano assegnati all'utente che esegue i comandi di distribuzione.

Con il routing rapido dell'app, il nome della funzione viene aggiunto come prefisso ai percorsi URL nell'app definita. Ad esempio, l'URL per richiamare il getter nell'esempio dell'app Express sopra è simile al seguente:

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

Se invochi le funzioni HTTP dietro un firewall o un filtro IP, puoi cercare gli indirizzi IP che Google utilizza per servire le funzioni HTTP.

Usa i moduli middleware con Cloud Functions

Se è necessario inserire le dipendenze del middleware per cose come il supporto dei cookie o CORS, chiamarle all'interno della funzione. Ad esempio, per abilitare il supporto CORS, aggiungi il seguente blocco:

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

Leggi i valori dalla richiesta

La tabella seguente elenca alcuni scenari comuni:

Tipo di contenuto Ente di richiesta Comportamento
application/json '{"name":"John"}' request.body.name è uguale a 'John'
application/octet-stream 'il mio testo' request.body è uguale a '6d792074657874' (i byte grezzi della richiesta; vedere la documentazione di Node.js Buffer )
text/plain 'il mio testo' request.body è uguale a 'il mio testo'
application/x-www-form-urlencoded 'nome=Giovanni' request.body.name è uguale a 'John'

Questa analisi viene eseguita dai seguenti body parser:

Supponiamo che la tua funzione venga chiamata con la seguente richiesta:

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

quindi i dati inviati verrebbero materializzati in:

Proprietà/Metodo Valore
req.method "INVIARE"
req.get('x-myheader') "123"
req.query.foo "baz"
req.body.text "qualcosa"
req.rawBody I byte non elaborati (non analizzati) della richiesta

Nell'esempio della funzione date() , la funzione verifica sia il parametro URL che il corpo per un valore di format per impostare il formato data/ora da utilizzare:

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

Termina le funzioni HTTP

Termina sempre una funzione HTTP con send() , redirect() o end() . In caso contrario, la funzione potrebbe continuare a essere eseguita ed essere terminata forzatamente dal sistema. Vedi anche Sincronizzazione, Asincrono e Promesse .

Dopo aver recuperato e formattato l'ora del server utilizzando il modulo moment Node.js, la funzione date() conclude inviando il risultato nella risposta HTTP:

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

Collegamento di funzioni HTTP a Firebase Hosting

Puoi connettere una funzione HTTP a Firebase Hosting. Le richieste sul tuo sito di hosting Firebase possono essere inviate tramite proxy a specifiche funzioni HTTP. Ciò ti consente anche di utilizzare il tuo dominio personalizzato con una funzione HTTP. Scopri di più sulla connessione di Cloud Functions a Firebase Hosting .