Creating a Db2 z/OS Connect API

Learn how to start the z/OS Connect Designer and create a new EmployeesApi z/OS Connect API project that calls Db2® to request data and services. Then, test your z/OS Connect API with the built-in Liberty REST client.

zosConnect-3.0 Applies to zosConnect-3.0.

Containers Applies to z/OS Connect container deployments.

After you download the files and set up the Db2 native REST service, create a workspace by using one of the following methods:

  • Creating a shared workspace where the z/OS Connect Designer will run. For example, Red Hat® OpenShift® Dev Space, Red Hat OpenShift Wazi Dev Space.

  • Creating a workspace on your local machine and running the z/OS Connect Designer with Docker.

You then use the z/OS Connect Designer to import the OpenAPI definition that is supplied with the GitHub sample and configure your API project. The z/OS Connect Designer is shown in Figure 1

Figure 1. The IBM® z/OS Connect Designer in a web browser
Screen capture to show the EmployeesApi Information page in z/OS Connect Designer in a web browser

To begin the tutorial, click the first task in the following list.