HTTP Tutorial

This simple tutorial demonstrates writing, deploying, and triggering an HTTP Cloud Function.

Objectives

• Write, deploy, and trigger an HTTP Cloud Function.

Costs

This tutorial uses billable components of Cloud Platform, including:

• Google Cloud Functions

Use the Pricing Calculator to generate a cost estimate based on your projected usage.

Before you begin

1. Sign in to your Google Account.

   If you don't already have one, sign up for a new account.

2. Select or create a GCP project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to the project selector page

3. Make sure that billing is enabled for your Google Cloud Platform project.

   Learn how to enable billing

4. Enable the Cloud Functions API.

   Enable the API

5. Update gcloud components:

   gcloud components update

6. Prepare your development environment.

   Node.js

   Go to the Node.js setup guide

   Python

   Go to the Python setup guide

   Go

   Go to the Go setup guide

Preparing the application

1. Clone the sample app repository to your local machine:

   Node.js

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   Python

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   Go

   git clone https://github.com/GoogleCloudPlatform/golang-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

2. Change to the directory that contains the Cloud Functions sample code:

   Node.js

   cd nodejs-docs-samples/functions/helloworld/

   Python

   cd python-docs-samples/functions/helloworld/

   Go

   cd golang-samples/functions/helloworld/

3. Take a look at the sample code:

   Node.js

   functions/helloworld/index.js

   View on GitHub Feedback

   /**
    * HTTP Cloud Function.
    * This function is exported by index.js, and is executed when
    * you make an HTTP request to the deployed function's endpoint.
    *
    * @param {Object} req Cloud Function request context.
    *                     More info: https://expressjs.com/en/api.html#req
    * @param {Object} res Cloud Function response context.
    *                     More info: https://expressjs.com/en/api.html#res
    */
   exports.helloGET = (req, res) => {
     res.send('Hello World!');
   };

   Python

   functions/helloworld/main.py

   View on GitHub Feedback

   def hello_get(request):
       """HTTP Cloud Function.
       Args:
           request (flask.Request): The request object.
           <http://flask.pocoo.org/docs/1.0/api/#flask.Request>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>.
       """
       return 'Hello World!'

   Go

   functions/helloworld/hello_world.go

   View on GitHub Feedback

   
   // Package helloworld provides a set of Cloud Functions samples.
   package helloworld
   
   import (
   	"fmt"
   	"net/http"
   )
   
   // HelloGet is an HTTP Cloud Function.
   func HelloGet(w http.ResponseWriter, r *http.Request) {
   	fmt.Fprint(w, "Hello, World!")
   }
   

Deploying the function

To deploy the function with an HTTP trigger, run the following command in the helloworld directory:

Node.js 8

gcloud functions deploy helloGET --runtime nodejs8 --trigger-http

Node.js 10 (Beta)

gcloud functions deploy helloGET --runtime nodejs10 --trigger-http

Node.js 6 (Deprecated)

gcloud functions deploy helloGET --runtime nodejs6 --trigger-http

Python

gcloud functions deploy hello_get --runtime python37 --trigger-http

Go

gcloud functions deploy HelloGet --runtime go111 --trigger-http

Triggering the function

To make an HTTP request to your function, run the following command:

Node.js

curl "https://REGION-PROJECT_ID.cloudfunctions.net/helloGET" 

Python

curl "https://REGION-PROJECT_ID.cloudfunctions.net/hello_get" 

Go

curl "https://REGION-PROJECT_ID.cloudfunctions.net/HelloGet" 

where

• REGION is the region where your function is deployed. This is visible in your terminal when your function finishes deploying.
• PROJECT_ID is your Cloud project ID. This is visible in your terminal when your function finishes deploying.

You can also visit the deployed function's endpoint in your browser to see the "Hello World!" message.

Cleaning up

To avoid incurring charges to your Google Cloud Platform account for the resources used in this tutorial:

Deleting the project

The easiest way to eliminate billing is to delete the project that you created for the tutorial.

To delete the project:

Caution: Deleting a project has the following effects:

• Everything in the project is deleted. If you used an existing project for this tutorial, when you delete it, you also delete any other work you've done in the project.
• Custom project IDs are lost. When you created this project, you might have created a custom project ID that you want to use in the future. To preserve the URLs that use the project ID, such as an appspot.com URL, delete selected resources inside the project instead of deleting the whole project.

If you plan to explore multiple tutorials and quickstarts, reusing projects can help you avoid exceeding project quota limits.

1. In the GCP Console, go to the Projects page.

   Go to the Projects page

2. In the project list, select the project you want to delete and click Delete .
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Deleting the Cloud Function

Deleting Cloud Functions does not remove any resources stored in Cloud Storage.

To delete the Cloud Function you created in this tutorial, run the following command:

Node.js

gcloud functions delete helloGET 

Python

gcloud functions delete hello_get 

Go

gcloud functions delete HelloGet 

You can also delete Cloud Functions from the Google Cloud Platform Console.