En Cloud Run, escribes una función HTTP cuando quieres invocar una función a través de una solicitud HTTP(S). Para permitir la semántica de HTTP, usa el framework de funciones y especifica la firma de la función HTTP para aceptar argumentos específicos de HTTP.
Implementa funciones de controlador de HTTP
En el siguiente ejemplo, se muestra el archivo de origen de una función básica HTTP para cada entorno de ejecución. Consulta la Estructura del directorio del código fuente para obtener información sobre dónde ubicar el código fuente.
Node.js
const functions = require('@google-cloud/functions-framework');
// Register an HTTP function with the Functions Framework
functions.http('myHttpFunction', (req, res) => {
// Your code here
// Send an HTTP response
res.send('OK');
});
En Node.js, registra una función de controlador HTTP con Functions Framework para Node.js. Tu función de controlador HTTP debe ser una función de middleware exprés que acepte los argumentos de solicitud y respuesta y que envíe una respuesta HTTP.
Cloud Run analiza el cuerpo de la solicitud de manera automática según el encabezado Content-Type de la solicitud mediante body-parser, para que puedas acceder a los objetos req.body y req.rawBody en tu controlador HTTP.
El punto de entrada de la función es el nombre con el que se registra el controlador en Functions Framework.
En este ejemplo, el punto de entrada es myHttpFunction.
Python
import functions_framework
# Register an HTTP function with the Functions Framework
@functions_framework.http
def my_http_function(request):
# Your code here
# Return an HTTP response
return 'OK'
En Python, registras una función de controlador HTTP con Functions Framework para Python. Tu función de controlador HTTP debe aceptar un objeto de solicitud de Flask como un argumento y mostrar un valor que Flask puede convertir en un objeto de respuesta HTTP.
El punto de entrada de la función es el nombre con el que se registra el controlador en Functions Framework.
En este ejemplo, el punto de entrada es my_http_function.
Go
package myhttpfunction
import (
"fmt"
"net/http"
"github.com/GoogleCloudPlatform/functions-framework-go/functions"
)
func init() {
// Register an HTTP function with the Functions Framework
functions.HTTP("MyHTTPFunction", myHTTPFunction)
}
// Function myHTTPFunction is an HTTP handler
func myHTTPFunction(w http.ResponseWriter, r *http.Request) {
// Your code here
// Send an HTTP response
fmt.Fprintln(w, "OK")
}
En Go, registra una función de controlador HTTP con Functions Framework para Go en tu función init(). La función del controlador HTTP debe usar la interfaz http.HandlerFunc estándar para enviar una respuesta HTTP.
El punto de entrada de la función es el nombre con el que se registra el controlador en Functions Framework.
En este ejemplo, el punto de entrada es MyHTTPFunction.
La función de tu controlador HTTP debe implementar la interfaz http.HandlerFunc estándar. Acepta una interfaz http.ResponseWriter que tu función usa para crear una respuesta a la solicitud, así como un puntero a una estructura http.Request que contiene los detalles de la solicitud HTTP entrante.
Java
package myhttpfunction;
import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
// Define a class that implements the HttpFunction interface
public class MyHttpFunction implements HttpFunction {
// Implement the service() method to handle HTTP requests
@Override
public void service(HttpRequest request, HttpResponse response) throws Exception {
// Your code here
// Send an HTTP response
response.getWriter().write("OK");
}
}
En Java, debes usar la API de Functions Framework para Java a fin de implementar una clase de controlador HTTP con la interfaz HttpFunction. El método service() debe enviar una respuesta HTTP.
El punto de entrada de la función es el nombre completamente calificado de la clase del controlador HTTP, incluido el nombre del paquete. En este ejemplo, el punto de entrada es myhttpfunction.MyHttpFunction.
Tu método service recibe un objeto HttpRequest que describe la solicitud HTTP entrante, así como un objeto HttpResponse que se propaga en tu función con un mensaje de respuesta.
.NET
using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;
namespace MyProject
{
// Define a class that implements the IHttpFunction interface
public class MyHttpFunction : IHttpFunction
{
// Implement the HandleAsync() method to handle HTTP requests
public async Task HandleAsync(HttpContext context)
{
// Your code here
// Send an HTTP response
await context.Response.WriteAsync("OK");
}
}
}
En los entornos de ejecución de .NET, usas Functions Framework para .NET a fin de implementar una clase de controlador HTTP con la interfaz de IHttpFunction. El método HandleAsync() acepta un objeto HttpContext de ASP.NET estándar como argumento y debe enviar una respuesta HTTP.
El punto de entrada de la función es el nombre completamente calificado de la clase de controlador HTTP, incluido el espacio de nombres. En este ejemplo, el punto de entrada es MyProject.MyHttpFunction.
Ruby
require "functions_framework"
# Register an HTTP function with the Functions Framework
FunctionsFramework.http "my_http_function" do |request|
# Your code here
# Return an HTTP response
"OK"
end
En Ruby, registras una función de controlador HTTP con Functions Framework para Ruby. La función de controlador HTTP debe aceptar un objeto de solicitud de Rack como argumento y mostrar un valor que se puede usar como respuesta HTTP.
El punto de entrada de la función es el nombre con el que se registra el controlador en Functions Framework.
En este ejemplo, el punto de entrada es my_http_function.
PHP
<?php
use Google\CloudFunctions\FunctionsFramework;
use Psr\Http\Message\ServerRequestInterface;
// Register an HTTP function with the Functions Framework
FunctionsFramework::http('myHttpFunction', 'myHttpHandler');
// Define your HTTP handler
function myHttpHandler(ServerRequestInterface $request): string
{
// Your code here
// Return an HTTP response
return 'OK';
}
En PHP, registras una función de controlador HTTP con Functions Framework para PHP.
Tu función de controlador HTTP debe aceptar un argumento que implemente la interfaz ServerRequestInterface de PSR-7 y debe mostrar una respuesta HTTP como una cadena o un objeto que implemente la interfaz ResponseInterface de PSR-7.
El punto de entrada de la función es el nombre con el que se registra el controlador en Functions Framework.
En este ejemplo, el punto de entrada es myHttpFunction.
Solicitudes y respuestas HTTP
Cuando registras una función de controlador HTTP con Functions Framework, tu controlador HTTP puede inspeccionar el método de solicitud y realizar diferentes acciones en función del método.
Cuando configuras un proveedor de eventos para que envíe solicitudes HTTP a tu función de Cloud Run, esta envía una respuesta HTTP. Si la función crea tareas en segundo plano (como subprocesos, futuros, objetos Promise de JavaScript, devoluciones de llamada o procesos del sistema), debes finalizar o resolver estas tareas antes de enviar una respuesta HTTP. Es posible que no se completen todas las tareas que no se finalicen antes de enviar la respuesta HTTP, lo que puede causar un comportamiento indefinido.
Cómo controlar CORs o compatibilidad con CORS
El uso compartido de recursos entre dominios (CORS) es una forma de permitir que las aplicaciones que se ejecutan en un dominio accedan a los recursos de otro dominio. Por ejemplo, es posible que debas permitir que el dominio realice solicitudes al dominio de Cloud Run Functions para acceder a la función.
Para permitir solicitudes de origen cruzado a tu función, configura el encabezado Access-Control-Allow-Origin según corresponda en la respuesta HTTP. Para las solicitudes de origen cruzado con solicitud preliminar, debes responder a la solicitud OPTIONS preliminar con un código de respuesta 204 y encabezados adicionales.
Node.js
Python
Go
Java
.NET
Ruby
PHP
Si CORS no está configurado correctamente, es posible que veas errores como el siguiente:
XMLHttpRequest cannot load https://YOUR_FUNCTION_URL. No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'https://YOUR_DOMAIN' is therefore not allowed access.
Limitaciones de CORS
Para las solicitudes preliminares de origen cruzado, las solicitudes OPTIONS preliminares se envían sin un encabezado de Authorization, por lo que se rechazarán en todas las funciones HTTP que requieran autenticación. Como las solicitudes de verificación previa fallan, la solicitud principal también lo hará. Para evitar esta limitación, usa una de las siguientes opciones:
- Permite invocaciones no autenticadas de tu función.
- Aloja tu app web y Cloud Run en el mismo dominio para evitar CORS. Para ello, integra Firebase Hosting en Cloud Run Functions.