Starting the z/OS Connect Designer in Red Hat CodeReady Workspaces

Use Red Hat CodeReady Workspace to start the z/OS Connect Designer.

Before you begin

Make sure that all prerequisite tasks are complete:
Note: When you start the z/OS Connect Designer for the tutorial, port 9443 is used for an HTTPS connection. If you want to try the exercises with an HTTP connection, use port 9080.

About this task

This topic is applicable to: Content applicable to application developers

Learn how to start the z/OS Connect Designer with Red Hat CodeReady Workspaces.

Procedure

  1. Start z/OS Connect Designer by using Red Hat CodeReady Workspace.
    When you open your new Red Hat CodeReady Workspace, you are presented with a Welcome To Your Workspace 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. Using the icons on the right of the browser, you can
    • View the project outline.
    • View the endpoints.
    • View My Workspace.
    Red Hat CodeReady Workspaces successfully created workspace.
  2. Click the plug icon to view the endpoints as shown in the figure.
    The endpoints available to your workspace are now visible.
    Red Hat CodeReady Workspaces viewing available endpoints.
    1. You have two choices to start z/OS Connect Designer.
    • Click the eye icon to start z/OS Connect Designer in preview mode.
      Red Hat CodeReady Workspaces viewing preview mode endpoint.
      Red Hat CodeReady Workspaces viewing z/OS Connect Designer in preview mode in Red Hat CodeReady Workspaces
    • Click the Open in new window icon to start z/OS Connect Designer in a new browser window.

      Attention: The z/OS Connect Designer UI might not appear immediately. Allow 10 - 15 seconds, then refresh your web browser.

      Red Hat CodeReady Workspaces viewing new window mode endpoint.
      Red Hat CodeReady Workspaces 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 CatalogManager.yaml. Warning indicators in the left navigation window show where your input is needed. Paths are endpoints (resources) that your API exposes, such as /items, /items/{id} or /orders and operations are the HTTP methods that are used to manipulate these paths, such as GET, POST, or DELETE. The next sections provide more information about resolving these warnings.
    Figure 1. The 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 CodeReady Workspaces and imported an OpenAPI definition.

What to do next

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