Importing an OpenAPI document into App Connect as an API (App Connect on IBM Cloud)

Complete these steps to add an imported API to App Connect:

1. From the App Connect Catalog page, click the APIs tab.
2. Click the Add API or web service icon [+].
   
3. Complete the "Add API or web service" panel as follows:
   1. From the "Import OpenAPI or web service document" view, select OpenAPI from the Document type drop-down list.
   2. Specify the file that you want to import. The file can be in a local or network drive, and can have any of these file extensions: .json, .yaml, or .yml. You can either drag and drop the file from its location in an open file browser into the boxed area, or click within the boxed area to open a file browser and locate the file. You'll see the file name in the boxed area, as shown in the following example.
      
   3. Click Next.
   4. From the "Review properties" view, complete the fields as follows:
      • Name: Specify a unique name of up to 30 characters by which your API can be identified on the APIs tab on the Catalog page, or within the flow editor. The default name is taken from the title property in the imported file if one exists, but you can update this field if required.
      • Description: Summarize the function of the API. The description is taken from the description property in the imported file if one exists, but you can update this field as required. Up to 250 characters is allowed.

      The defined operations in the imported file are displayed as actions. For information about how these actions are grouped, see OpenAPI document guidelines.

      
4. Click Add API. Your API is displayed on the APIs tab and is tagged with an imported label and a community icon that you can click to reveal additional details.

   You can expand the API to view the available actions and can use these actions in your flows.