Converting a Product YAML file to use DataPower API Gateway

IBM® API Connect now supports DataPower® API Gateway. You can optionally specify this gateway type in your Product YAML file.

Before you begin

IBM API Connect provides two gateway types, DataPower Gateway (v5 compatible) and DataPower API Gateway.

DataPower Gateway (v5 compatible) has been available with IBM API Connect for a number of years. The DataPower API Gateway is a new gateway that has been designed with APIs in mind, and with the same security focus as DataPower Gateway (v5 compatible).

For more information on how to choose which gateway type to use, see API Connect gateway types.

About this task

Product definitions can specify only one type of gateway. The type of gateway must match the gateway type that is used by the APIs that are included in the product. If you want to take advantage of the capabilities of DataPower API Gateway, you can easily modify your existing Product definitions to specify it as the gateway type.

Procedure

  1. Verify that the APIs in the product specify DataPower API Gateway as the gateway type, and that the APIs have been converted for use with the DataPower API Gateway.
  2. Open the Product YAML file for editing.

    For example:

    
product: '1.0.0'        .

info:
  name: testprod
  title: testprod
  version: 1.0.0
          .
          .
          .
  3. Add a gateways: setting, and specify datapower-api-gateway.

    For example:

     
product: '1.0.0'        .

info:
  name: testprod
  title: testprod
  version: 1.0.0
gateways:
  - datapower-api-gateway
            .
            .
            .
  4. Save the modified YAML file.