Connect with IBM API Connect

🎯context

You want to use a REST API provided by IBM DevOps Solution Workbench within IBM API Connect.

Description

This How-To will show you the way of adding annotations to APIs in IBM DevOps Solution Workbench for the purpose of using the generated API specifications in IBM API Connect.

Steps

❗️info

The following steps can only work for Domain Service Projects!

Create an API namespace in the Solution Designer. Navigate to the step "Build Information" and select the checkbox "IBM API Connect".

The following code is the default configuration for IBM API Connect extensions.
```
x-ibm-configuration:
  phase: identified
  type: rest
  testable: false
  enforced: false
  cors:
    enabled: false
```
Now, you can fill in IBM API Connect related details for your REST API. Adjust the default configuration according to your needs. For further information please read the IBM API Connect documentation. The defined details will extend the the OpenAPI specification so that it could be integrated into IBM API Connect easily.
Design the API operations for the service and commit and push the changes. For more details take a look at our course Design API Paths and Operations.
Implement the operations using the Solution CLI. For more details take a look at our course Implement API Operations.
Create and trigger a pipeline in the Solution Designer to deploy the service.
Discover the service in the Environment page and confirm that the OpenAPI specification contains the configuration for API Connect. Then download the specification.
Upload the specification to IBM API Connect and model the product then in IBM API Connect.