Starting the z/OS Connect Designer in Red Hat OpenShift Dev Spaces

Use Red Hat OpenShift Dev Spaces to start the z/OS Connect Designer.

Before you begin

zosConnect-3.0 Applies to zosConnect-3.0.

Containers Applies to z/OS Connect container deployments.

Make sure that all prerequisite tasks are complete:

Note: When you start the z/OS Connect Designer for the tutorial, port 9080 is used for an HTTPS connection. If you want to try the exercises with an HTTP connection, use port 9443.

About this task

Learn how to start the z/OS Connect Designer with Red Hat OpenShift Dev Spaces.

Procedure

  1. Start z/OS Connect Designer by using Red Hat OpenShift Dev Spaces.
    When you open your new Red Hat OpenShift Dev Spaces, you are presented with a Red Hat Open Shift Dev Spaces screen for you to start to explore the z/OS Connect CICS sample API project.

    The EXPLORER is in the main window of the browser for you to explore the project. In EXPLORER, you can view the:
    • (WORKSPACE)
    • OUTLINE
    • TIMELINE
    • ENDPOINTS
    Figure 1. Red Hat OpenShift Dev Spaces Welcome page with EXPLORER options
    Red Hat OpenShift Dev Spaces Welcome screen
  2. Select ENDPOINTS.
    The endpoints available to your workspace are now visible. Click the Open in new window icon to start z/OS Connect Designer in a new browser window.
    Figure 2. Open in new window icon in the ENDPOINTS panel
    Red Hat OpenShift Dev Spaces viewing new window mode endpoint.
    Attention: The z/OS Connect Designer UI might not appear immediately. Allow 10 - 15 seconds, then refresh your web browser.

    The z/OS Connect Designer is displayed in a new browser window as shown in the figure.

    Figure 3. z/OS Connect Designer displayed in a new browser
    Red Hat OpenShift Dev Spaces viewing z/OS Connect Designer in a browser.
  3. Explore the z/OS Connect Designer interface.
    You can see the Paths and operations that are defined in the CatalogManagerApi. Warning indicators (An amber exclamation mark) in the navigation panel show where your input is needed.
    Paths are endpoints (resources) that your API displays, such as /items, /items/{id}, or /orders.
    Operations are the HTTP methods that are used to manipulate these paths, such as GET, POST, or DELETE.
    You can fix these warning indicators by defining the GET and POST operations by creating z/OS Assets and mapping the relationship between your API request and the endpoint. For more information, see Define the GET operation for the /items path and Define the POST operation for the /orders path.
    Figure 4. Paths page in the z/OS Connect Designer
    An imported OpenAPI definition in the z/OS Connect Designer

Results

You successfully started z/OS Connect Designer with Red Hat OpenShift Dev Spaces and imported an OpenAPI definition.

What to do next

Continue developing your API project by defining the operations for the CICS CatalogManager sample.