Importing an OpenAPI 3 document in the IBM z/OS Connect Designer

Importing an OpenAPI 3 document in the IBM® z/OS Connect Designer for an API project.

Before you begin

zosConnect-3.0 Applies to zosConnect-3.0.

Containers Applies to z/OS Connect container deployments.

Note: An OpenAPI 3 document is required to build an API project with z/OS Connect Designer. For more information on how to create an OpenAPI 3 document, see Creating a simple OpenAPI 3.0 document.

About this task

When z/OS Connect Designer starts with no API project defined, the first screen is the Import OpenAPI document screen. See Figure 1.

Complete the following procedure to import an OpenAPI document to create your z/OS Connect Designer API project.

Figure 1. Import OpenAPI document screen
Import OpenAPI document screen

Procedure

  1. Locate the OpenAPI 3 document project file.
    In most instances, this is stored in source control management to download. For more information, see Checking your IBM z/OS Connect API project into source control.
  2. Complete one of the following three choices.
    • Drag and Drop the OpenAPI 3 document to the Import OpenAPI document window.
    • Click select a file to open a window to find and select you OpenAPI 3 document.
    • Click Specify a URL and enter the URL to your OpenAPI 3 document.
      Note: z/OS Connect Designer can be configured to allow URL imports only from specified hosts using the zosconnect_remote_download_allowlist MicroProfile Config property. For more information about allowlist property, see Configuring an allowlist for IBM z/OS Connect Designer.
    Figure 2 shows a successful OpenAPI document import.

    Figure 2. A successful OpenAPI document import
    A successful OpenAPI document import
    Figure 3 shows an unsuccessful OpenAPI document import. Review the error and update the API project file to import. For more information on z/OS Connect messages, see BAQW messages.

    Figure 3. An unsuccessful import of OpenAPI project
    An unsuccessful import of OpenAPI project
  3. Click Create API.
  4. z/OS Connect Designer starts the API project.

Results

z/OS Connect Designer opens the API project Information page. In Figure 4, the EmployeesApi project details are displayed.
Figure 4. z/OS Connect Designer project information
z/OS Connect Designer project information