Assignments Set-Up

This page details how to prepare for working on the assignments.

The Assignments Repository

There is a git repository that contains the assets you need to perform the assignments. Download the repository from the 📦 menu and extract the archive to a location on your computer. Each assignment will start with the instructions to use the repository’s content.

Prepare Postman

To use Postman to perform requests with gRPC, you need to import the API definition for the endpoint you’ll be posting messages to.

Download the .proto file for the Zeebe Gateway and save it to your computer. This file contains the interface specification with the methods and messages and by Zeebe. The current version of the file can be found at this location: https://raw.githubusercontent.com/camunda-cloud/zeebe/develop/gateway-protocol/src/main/proto/gateway.proto

Go into Postman and add the APIs section to the workspace sidebar if it’s not already there

postman configure workspace sidebar
Figure 1. Configure the workspace sidebar
postman add apis
Figure 2. Add APIs to the workspace sidebar
postman apis section
Figure 3. APIs section added to the workspace sidebar

Now select the APIs section. At the top left, the button allows you to create a new API. Name it Zeebe Gateway.

In the sidebar, select the three dots that appear when hovering the API and select the Add definition  Import Files option. Select the downloaded gateway.proto file and Postman will import its contents into a new Definition subsection and list the gateway.proto in that section.

postman definition imported
Figure 4. After importing API definition

That’s it for the Postman preparations; we’ll use the definition later on. For now, just go back to the Collections section in the workspace sidebar and leave Postman open.

That’s all for the set up. Let’s go!