Loading...
No results found.

    Get Started with API Gateway

    Get access to 700+ labs and courses

    Getting Started with API Gateway: Challenge Lab

    Lab 45 minutes universal_currency_alt 1 Credit show_chart Introductory
    info This lab may incorporate AI tools to support your learning.
    Get access to 700+ labs and courses

    ARC109

    Overview

    In a challenge lab you’re given a scenario and a set of tasks. Instead of following step-by-step instructions, you will use the skills learned from the labs in the course to figure out how to complete the tasks on your own! An automated scoring system (shown on this page) will provide feedback on whether you have completed your tasks correctly.

    When you take a challenge lab, you will not be taught new Google Cloud concepts. You are expected to extend your learned skills, like changing default values and reading and researching error messages to fix your own mistakes.

    To score 100% you must successfully complete all tasks within the time period!

    Setup

    Before you click the Start Lab button

    Read these instructions. Labs are timed and you cannot pause them. The timer, which starts when you click Start Lab, shows how long Google Cloud resources are made available to you.

    This hands-on lab lets you do the lab activities in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials you use to sign in and access Google Cloud for the duration of the lab.

    To complete this lab, you need:

    • Access to a standard internet browser (Chrome browser recommended).
    Note: Use an Incognito (recommended) or private browser window to run this lab. This prevents conflicts between your personal account and the student account, which may cause extra charges incurred to your personal account.
    • Time to complete the lab—remember, once you start, you cannot pause a lab.
    Note: Use only the student account for this lab. If you use a different Google Cloud account, you may incur charges to that account.

    Challenge scenario

    You are just starting your junior data analyst role. So far you have been helping teams create, manage and access backend data resources.

    You are expected to have the skills and knowledge for these tasks.

    Your challenge

    You are asked to help a newly formed development team with some of their initial work on a new project around exposing backend services as APIs. You have been asked to assist the team with their efforts using API Gateway, and you receive a request to complete the following tasks:

    • Develop the backend system using a Cloud Run function.
    • Deploy and manage an API exposing the backend service with a fully managed gateway.
    • Subscribe to messages published on a Pub/Sub topic to react to events.

    Each task is described below, good luck!

    Task 1. Create a Cloud Run function

    Note: Cloud Run functions (2nd gen) depend on the Cloud Run Admin APIs. The Cloud Run Admin APIs have been enabled for you at the start of this lab. It may however take a few minutes for all of the enabled services to propagate. If you experience an issue when deploying your Cloud Run function, wait a few minutes then try again.

    Create a new Cloud Run function (2nd gen) called gcfunction in the region using Node.js 22 and allowing unauthenticated invocations. For now, simply have the function return "Hello World!" when invoked.

    Click Check my progress to verify the objective. Create a Cloud Run function.

    Task 2. Create an API Gateway

    Once the Cloud Run function is deployed, configure an API Gateway to proxy requests to the backend.

    Create a file named openapispec.yaml (using the code below), which references the Cloud Run function deployed in Task 1.

    Use openapispec.yaml when deploying the API Gateway with the following properties:

    Name Value
    Display Name gcfunction API (wherever requested)
    API ID gcfunction-api
    Select a service account Compute Engine default service account
    Location
    Config Name gcfunction-api
    swagger: '2.0' info: title: gcfunction API description: Sample API on API Gateway with a Google Cloud Run functions backend version: 1.0.0 schemes: - https produces: - application/json x-google-backend: address: https://gcfunction-{{{ project_0.startup_script.project_number | PROJECT_NUMBER }}}.{{{project_0.default_region | REGION}}}.run.app paths: /gcfunction: get: summary: gcfunction operationId: gcfunction responses: '200': description: A successful response schema: type: string Note: It will take several minutes (~10 minutes) for the Create Gateway operation to complete. To check the status of the creation and deployment process, you can click the Notifications icon (bell icon) in the top main navigation bar to display a status notification. Please ensure that the icon status for Creating gateway "gcfunction API" has a green check next to it before proceeding.

    Click Check my progress to verify the objective. Create an API Gateway.

    Task 3. Create a Pub/Sub Topic and Publish Messages via API Backend

    The development team would like the API backend to publish messages to a new Pub/Sub topic named demo-topic.

    Create a new Pub/Sub topic (demo-topic) and push messages to it in the Cloud Run function deployed earlier. Be sure to keep the option to create a default subscription enabled when creating the topic.

    Use the snippet below to update the package.json file and index.js code in the Cloud Run function deployed in Task 1.

    package.json

    { "dependencies": { "@google-cloud/functions-framework": "^3.0.0", "@google-cloud/pubsub": "^3.4.1" } }

    index.js

    /** * Responds to any HTTP request. * * @param {!express:Request} req HTTP request context. * @param {!express:Response} res HTTP response context. */ const {PubSub} = require('@google-cloud/pubsub'); const pubsub = new PubSub(); const topic = pubsub.topic('demo-topic'); const functions = require('@google-cloud/functions-framework'); exports.helloHttp = functions.http('helloHttp', (req, res) => { // Send a message to the topic topic.publishMessage({data: Buffer.from('Hello from Cloud Run functions!')}); res.status(200).send("Message sent to Topic demo-topic!"); });

    Redeploy the Cloud Run function once the index.js and package.json files have been updated.

    Next, invoke the Cloud Run function via API Gateway. If done correctly, a message will be published to the topic demo-topic you've created in this task.

    Note: It will take several minutes (~5 minutes) for the messages published to appear in the Messages section of the subscription after invoking the API Gateway endpoint.

    Click Check my progress to verify the objective. Create a Pub/Sub Topic and Publish Messages via API Backend.

    Congratulations!

    You have completed the challenge to deploy and manage an API exposing the backend service with a fully managed gateway.

    Google Cloud training and certification

    ...helps you make the most of Google Cloud technologies. Our classes include technical skills and best practices to help you get up to speed quickly and continue your learning journey. We offer fundamental to advanced level training, with on-demand, live, and virtual options to suit your busy schedule. Certifications help you validate and prove your skill and expertise in Google Cloud technologies.

    Manual Last Updated April 01, 2025

    Lab Last Tested April 01, 2025

    Copyright 2025 Google LLC All rights reserved. Google and the Google logo are trademarks of Google LLC. All other company and product names may be trademarks of the respective companies with which they are associated.

    Previous Next

    Before you begin

    1. Labs create a Google Cloud project and resources for a fixed time
    2. Labs have a time limit and no pause feature. If you end the lab, you'll have to restart from the beginning.
    3. On the top left of your screen, click Start lab to begin

    This content is not currently available

    We will notify you via email when it becomes available

    Great!

    We will contact you via email if it becomes available

    One lab at a time

    Confirm to end all existing labs and start this one

    Use private browsing to run the lab

    Use an Incognito or private browser window to run this lab. This prevents any conflicts between your personal account and the Student account, which may cause extra charges incurred to your personal account.
    Preview